API Reference

Pipelines

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List File Page Screenshots

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

List metadata for all screenshots of pages from a file.

Path ParametersExpand Collapse

id: string

Query ParametersExpand Collapse

organization_id: optional string

project_id: optional string

Cookie ParametersExpand Collapse

session: optional string

ReturnsExpand Collapse

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

List File Page Screenshots

HTTP

HTTP

TypeScript

Python

Java

Go

CLI Tool

curl https://api.cloud.llamaindex.ai/api/v1/files/$ID/page_screenshots \
    -H "Authorization: Bearer $LLAMA_CLOUD_API_KEY"

200 example

[
  {
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "image_size": 0,
    "page_index": 0,
    "metadata": {
      "foo": "bar"
    }
  }
]

Returns Examples

200 example

[
  {
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "image_size": 0,
    "page_index": 0,
    "metadata": {
      "foo": "bar"
    }
  }
]