List File Page Screenshots

GET 
/api/v1/files/:id/page_screenshots

List metadata for all screenshots of pages from a file.

Request

Path Parameters

id uuidrequired

Query Parameters

project_id any

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

page_index Page Index (integer)required

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

file_id uuidrequired

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

image_size Image Size (integer)required

The size of the image in bytes

• ]

Example (from schema)

[
  {
    "page_index": 0,
    "file_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "image_size": 0
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...