# Images

## List File Page Screenshots

`List<ImageListPageScreenshotsResponse> pipelines().images().listPageScreenshots(ImageListPageScreenshotsParamsparams = ImageListPageScreenshotsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/api/v1/files/{id}/page_screenshots`

List metadata for all screenshots of pages from a file.

### Parameters

- `ImageListPageScreenshotsParams params`

  - `Optional<String> id`

  - `Optional<String> organizationId`

  - `Optional<String> projectId`

### Example

```java
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.ImageListPageScreenshotsParams;
import com.llamacloud_prod.api.models.pipelines.images.ImageListPageScreenshotsResponse;

public final class Main {
    private Main() {}

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

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

#### Response

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

## Get File Page Screenshot

`JsonValue pipelines().images().getPageScreenshot(ImageGetPageScreenshotParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/api/v1/files/{id}/page_screenshots/{page_index}`

Get screenshot of a page from a file.

### Parameters

- `ImageGetPageScreenshotParams params`

  - `String id`

  - `Optional<Long> pageIndex`

  - `Optional<String> organizationId`

  - `Optional<String> projectId`

### Returns

- `class ImageGetPageScreenshotResponse:`

### Example

```java
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.ImageGetPageScreenshotParams;
import com.llamacloud_prod.api.models.pipelines.images.ImageGetPageScreenshotResponse;

public final class Main {
    private Main() {}

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

        ImageGetPageScreenshotParams params = ImageGetPageScreenshotParams.builder()
            .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .pageIndex(0L)
            .build();
        ImageGetPageScreenshotResponse response = client.pipelines().images().getPageScreenshot(params);
    }
}
```

#### Response

```json
{}
```

## Get File Page Figure

`JsonValue pipelines().images().getPageFigure(ImageGetPageFigureParamsparams, RequestOptionsrequestOptions = RequestOptions.none())`

**get** `/api/v1/files/{id}/page-figures/{page_index}/{figure_name}`

Get a specific figure from a page of a file.

### Parameters

- `ImageGetPageFigureParams params`

  - `String id`

  - `long pageIndex`

  - `Optional<String> figureName`

  - `Optional<String> organizationId`

  - `Optional<String> projectId`

### Returns

- `class ImageGetPageFigureResponse:`

### Example

```java
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.ImageGetPageFigureParams;
import com.llamacloud_prod.api.models.pipelines.images.ImageGetPageFigureResponse;

public final class Main {
    private Main() {}

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

        ImageGetPageFigureParams params = ImageGetPageFigureParams.builder()
            .id("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
            .pageIndex(0L)
            .figureName("figure_name")
            .build();
        ImageGetPageFigureResponse response = client.pipelines().images().getPageFigure(params);
    }
}
```

#### Response

```json
{}
```

## 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.

### Parameters

- `ImageListPageFiguresParams params`

  - `Optional<String> id`

  - `Optional<String> organizationId`

  - `Optional<String> projectId`

### Example

```java
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");
    }
}
```

#### Response

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