Skip to content
Developer Documentation
API Reference
Pipelines

Images

List File Page Screenshots
client.pipelines.images.listPageScreenshots(stringid, ImageListPageScreenshotsParams { organization_id, project_id } query?, RequestOptionsoptions?): ImageListPageScreenshotsResponse { file_id, image_size, page_index, metadata }
GET/api/v1/files/{id}/page_screenshots
Get File Page Screenshot
client.pipelines.images.getPageScreenshot(numberpageIndex, ImageGetPageScreenshotParams { id, organization_id, project_id } params, RequestOptionsoptions?): ImageGetPageScreenshotResponse
GET/api/v1/files/{id}/page_screenshots/{page_index}
Get File Page Figure
client.pipelines.images.getPageFigure(stringfigureName, ImageGetPageFigureParams { id, page_index, organization_id, project_id } params, RequestOptionsoptions?): ImageGetPageFigureResponse
GET/api/v1/files/{id}/page-figures/{page_index}/{figure_name}
List File Pages Figures
client.pipelines.images.listPageFigures(stringid, ImageListPageFiguresParams { organization_id, project_id } query?, RequestOptionsoptions?): ImageListPageFiguresResponse { confidence, figure_name, figure_size, 4 more }
GET/api/v1/files/{id}/page-figures
ModelsExpand Collapse
ImageListPageScreenshotsResponse = Array<ImageListPageScreenshotsResponseItem>
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?: Record<string, unknown> | null

Metadata for the screenshot

ImageGetPageScreenshotResponse = unknown
ImageGetPageFigureResponse = unknown
ImageListPageFiguresResponse = Array<ImageListPageFiguresResponseItem>
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?: boolean

Whether the figure is likely to be noise

metadata?: Record<string, unknown> | null

Metadata for the figure

Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/