List File Page Screenshots

client.pipelines.images.listPageScreenshots(, ?, ?): ImageListPageScreenshotsResponse { file_id, image_size, page_index, metadata }

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

List metadata for all screenshots of pages from a file.

ParametersExpand Collapse

id: string

query: ImageListPageScreenshotsParams { organization_id, project_id }

organization_id?: string | null

project_id?: string | null

ReturnsExpand 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

List File Page Screenshots

import LlamaCloud from '@llamaindex/llama-cloud';

const client = new LlamaCloud({
  apiKey: process.env['LLAMA_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.pipelines.images.listPageScreenshots(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response);

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

Returns Examples

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