List File Pages Figures

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

List metadata for all figures from all pages of 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

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

List File Pages Figures

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

[
  {
    "confidence": 0,
    "figure_name": "figure_name",
    "figure_size": 0,
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "page_index": 0,
    "is_likely_noise": true,
    "metadata": {
      "foo": "bar"
    }
  }
]

Returns Examples

[
  {
    "confidence": 0,
    "figure_name": "figure_name",
    "figure_size": 0,
    "file_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "page_index": 0,
    "is_likely_noise": true,
    "metadata": {
      "foo": "bar"
    }
  }
]