Document AI — DMS

Document outline (headings and page ranges)

Read the outline of ONE document: headings with page ranges, no full text. Use first on long documents, then po_documents_section_text_get with node_id. depth 1-4 (default 2). Optional node_id returns that subtree. Optional pages (comma...

get/documents/structure-get

Request

  • Base URL: https://api.paperoffice.ai/latest
  • URL: https://api.paperoffice.ai/latest/documents/structure-get
  • Auth: HTTP bearer

Query parameters

pofidstring required

PaperOffice File ID. Numeric documents_id is also accepted.

depthinteger

How many outline levels to return.

node_idstring

6-digit node id. Returns that node and its subtree.

pagesstring

Comma-separated page numbers to map onto the outline (at most 20; invalid entries are listed in pages_ignored).

build'0' | '1'

1 builds the outline on first read when it is missing. 0 only returns an existing outline.

Response

Success

statusstring required
pofidstring required
builtboolean required
modestring

headings, page_groups, headings_capped or empty

node_countinteger
truncatedboolean
total_pagesinteger
built_atstring

UTC time the cached outline was built (ISO 8601)

pages_truncatedboolean

true when more than 20 pages were requested

pages_ignoredstring[]

pages entries that were not mapped (not a number, below 1 or beyond the last page)

Changes

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