Sign in
Page

Retrieve page

Get a page object.

get/api/v1/pages/{pageID}

Path parameters

pageIDinteger required

A unique integer value identifying this page.

Response

OK

idinteger required

ID of the page

urlstring uri required

URL of the page.

annotationstring uri required

Annotation that page belongs to.

numberinteger required

Page index, first page has index 1.

rotation_deginteger required

Page rotation.

mime_typestring required

MIME type of the page (image/png).

s3_namestring required

Storage key of the page file. Internal use only.

contentstring uri required

Link to the page raw content (e.g. pdf file).

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

widthinteger nullable required

Page width in pixels (for internal purposes only)

heightinteger nullable required

Page height in pixels (for internal purposes only)

Example response

{
  "id": 558598,
  "url": "https://example.rossum.app/api/v1/pages/558598",
  "annotation": "https://example.rossum.app/api/v1/annotations/314528",
  "number": 1,
  "mime_type": "image/png",
  "s3_name": "7eb0dcc0faa8868b55fb425d21cc60dd",
  "content": "https://example.rossum.app/api/v1/pages/558598/content",
  "metadata": {
    "some_key": "some_value"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.