Documents

Get all page descriptions for a document

Retrieves all page descriptions associated with a document.

get/api/v0/documents/{document_id}/page-descriptions

Request

Base URL
https://api.outerport.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/outerport/apis/outerport-api/docs/api/v0/documents/:document_id/page-descriptions/get.ts
A function with typed inputs. Its response is checked against the schema.

document_idstring uuid required

Successful Response

public_idstring uuid required

The public id of the page description

page_numberinteger required

The page number (0-indexed)

descriptionstring required

The generated description for this page

page_typestring nullable

Page classification (e.g. general_document, mechanical_drawing)

created_atstring date-time required

When the description was created

updated_atstring date-time required

When the description was last updated

Nov 9, 2026ecd5b922e78a Revision changes
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status