API Reference

Pipelines

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get File Page Screenshot

pipelines.images.get_page_screenshot(intpage_index, ImageGetPageScreenshotParams**kwargs) -> object

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

Get screenshot of a page from a file.

ParametersExpand Collapse

id: str

page_index: int

organization_id: Optional[str]

project_id: Optional[str]

ReturnsExpand Collapse

object

Get File Page Screenshot

Python

HTTP

TypeScript

Python

Java

Go

CLI Tool

import os
from llama_cloud import LlamaCloud

client = LlamaCloud(
    api_key=os.environ.get("LLAMA_CLOUD_API_KEY"),  # This is the default and can be omitted
)
response = client.pipelines.images.get_page_screenshot(
    page_index=0,
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response)

200 example

{}

Returns Examples

200 example

{}