API Reference

Pipelines

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Images

List File Page Screenshots

GET/api/v1/files/{id}/page_screenshots

Get File Page Screenshot

GET/api/v1/files/{id}/page_screenshots/{page_index}

Get File Page Figure

GET/api/v1/files/{id}/page-figures/{page_index}/{figure_name}

List File Pages Figures

GET/api/v1/files/{id}/page-figures

ModelsExpand Collapse

ImageListPageScreenshotsResponse = array of object { file_id, image_size, page_index, metadata }

file_id: string

The ID of the file that the page screenshot was taken from

formatuuid

image_size: number

The size of the image in bytes

minimum0

page_index: number

The index of the page for which the screenshot is taken (0-indexed)

minimum0

metadata: optional map[unknown]

Metadata for the screenshot

ImageGetPageScreenshotResponse = unknown

ImageGetPageFigureResponse = unknown

ImageListPageFiguresResponse = array of object { confidence, figure_name, figure_size, 4 more }

confidence: number

The confidence of the figure

maximum1

minimum0

figure_name: string

The name of the figure

figure_size: number

The size of the figure in bytes

minimum0

file_id: string

The ID of the file that the figure was taken from

formatuuid

page_index: number

The index of the page for which the figure is taken (0-indexed)

minimum0

is_likely_noise: optional boolean

Whether the figure is likely to be noise

metadata: optional map[unknown]

Metadata for the figure