# Images

## List File Page Screenshots

`IReadOnlyList<ImageListPageScreenshotsResponse> Pipelines.Images.ListPageScreenshots(ImageListPageScreenshotsParamsparameters, CancellationTokencancellationToken = default)`

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

List metadata for all screenshots of pages from a file.

### Parameters

- `ImageListPageScreenshotsParams parameters`

  - `required string id`

  - `string? organizationID`

  - `string? projectID`

### Example

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

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

Console.WriteLine(response);
```

#### Response

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

## Get File Page Screenshot

`JsonElement Pipelines.Images.GetPageScreenshot(ImageGetPageScreenshotParamsparameters, CancellationTokencancellationToken = default)`

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

Get screenshot of a page from a file.

### Parameters

- `ImageGetPageScreenshotParams parameters`

  - `required string id`

    Path param

  - `required Long pageIndex`

    Path param

  - `string? organizationID`

    Query param

  - `string? projectID`

    Query param

### Example

```csharp
ImageGetPageScreenshotParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    PageIndex = 0,
};

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

Console.WriteLine(response);
```

#### Response

```json
{}
```

## Get File Page Figure

`JsonElement Pipelines.Images.GetPageFigure(ImageGetPageFigureParamsparameters, CancellationTokencancellationToken = default)`

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

Get a specific figure from a page of a file.

### Parameters

- `ImageGetPageFigureParams parameters`

  - `required string id`

    Path param

  - `required Long pageIndex`

    Path param

  - `required string figureName`

    Path param

  - `string? organizationID`

    Query param

  - `string? projectID`

    Query param

### Example

```csharp
ImageGetPageFigureParams parameters = new()
{
    ID = "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    PageIndex = 0,
    FigureName = "figure_name",
};

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

Console.WriteLine(response);
```

#### Response

```json
{}
```

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

### Parameters

- `ImageListPageFiguresParams parameters`

  - `required string id`

  - `string? organizationID`

  - `string? projectID`

### Example

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

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

Console.WriteLine(response);
```

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