API Reference

Pipelines

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List File Pages Figures

IReadOnlyList<ImageListPageFiguresResponse> Pipelines.Images.ListPageFigures(ImageListPageFiguresParamsparameters, CancellationTokencancellationToken = default)

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

List metadata for all figures from all pages of a file.

ParametersExpand Collapse

ImageListPageFiguresParams parameters

required string id

string? organizationID

string? projectID

List File Pages Figures

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

ImageListPageFiguresParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
};

var response = await client.Pipelines.Images.ListPageFigures(parameters);

Console.WriteLine(response);

200 example

[
  {
    "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

200 example

[
  {
    "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"
    }
  }
]