API Reference

Pipelines

Images

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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.

ParametersExpand Collapse

ImageGetPageScreenshotParams parameters

required string id

Path param

formatuuid

required Long pageIndex

Path param

string? organizationID

Query param

formatuuid

string? projectID

Query param

formatuuid

Get File Page Screenshot

C#

HTTP

TypeScript

Python

Go

Java

C#

CLI Tool

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

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

Console.WriteLine(response);

200 example

{}

Returns Examples

200 example

{}