Sign in
Page Screenshots

List File Page Screenshots

Changed on

List metadata for all screenshots of pages from a file.

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

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

page_indexinteger required

The index of the page for which the screenshot is taken (0-indexed)

file_idstring uuid required

The ID of the file that the page screenshot was taken from

image_sizeinteger required

The size of the image in bytes

metadataobject nullable

Metadata for the screenshot

Changes