API Reference

Pipelines

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List File Pages Figures

List<ImageListPageFiguresResponse> pipelines().images().listPageFigures(ImageListPageFiguresParamsparams = ImageListPageFiguresParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

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

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

ParametersExpand Collapse

ImageListPageFiguresParams params

Optional<String> id

Optional<String> organizationId

Optional<String> projectId

List File Pages Figures

Java

HTTP

TypeScript

Python

Java

Go

CLI Tool

package com.llamacloud_prod.api.example;

import com.llamacloud_prod.api.client.LlamaCloudClient;
import com.llamacloud_prod.api.client.okhttp.LlamaCloudOkHttpClient;
import com.llamacloud_prod.api.models.pipelines.images.ImageListPageFiguresParams;
import com.llamacloud_prod.api.models.pipelines.images.ImageListPageFiguresResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        LlamaCloudClient client = LlamaCloudOkHttpClient.fromEnv();

        List<ImageListPageFiguresResponse> response = client.pipelines().images().listPageFigures("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
    }
}

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