Document AI — DMS

Read one document section (outline node or page range)

Read the text of one outline section or page range of ONE document. Pass node_id from po_documents_structure_get, or start_page and end_page. At most 12 pages, each page capped; an end_page beyond the last page is clamped...

get/documents/section-text-get

Request

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

Query parameters

pofidstring required

PaperOffice File ID. Numeric documents_id is also accepted.

node_idstring

6-digit node id from structure-get.

start_pageinteger

First page (1 or greater) when node_id is omitted; requires end_page.

end_pageinteger

Last page (1 or greater) when node_id is omitted; clamped to the last page of the document.

Response

Success

statusstring required
pofidstring required
node_idstring
titlestring
start_pageinteger
end_pageinteger
range_truncatedboolean
total_pagesinteger
range_clampedboolean

true when end_page was reduced to the last page of the document

Changes

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