{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/docs/ai/document-ai/inspecting-document-content/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Inspecting Content

\n

Document AI provides read-only endpoints for reviewing processed document content without downloading the original file.

\n

Use them to retrieve:

\n\n

These endpoints are available after processing has produced results.

\n

View content in Shipwell

\n

Open a completed run in the Run Inspector. The document viewer can display extracted values and their locations alongside the source page.

\n\n

Get the document outline

\n

The outline is the best starting point for programmatic inspection:

\n\n
\n
\n curlpython\n
\n
\n
\n
/outline" \\\\\n -H "Authorization: Token "`, `61346118564664100000`)\"\n >\n
Copy
\n
Copied
\n
\n 
curl "https://sandbox-api.shipwell.com/document-store/documents/<document-id>/outline" \\\n  -H "Authorization: Token <user-token>"
\n
\n
/outline",\n headers={"Authorization": "Token "},\n timeout=30,\n)\nresponse.raise_for_status()\noutline = response.json()`, `61477378004357280000`)\"\n >\n
Copy
\n
Copied
\n
\n 
import requests\n\nresponse = requests.get(\n    \"https://sandbox-api.shipwell.com/document-store/documents/<document-id>/outline\",\n    headers={\"Authorization\": \"Token <user-token>\"},\n    timeout=30,\n)\nresponse.raise_for_status()\noutline = response.json()
\n
\n
\n \n

It returns:

\n\n

For a split document, use result_breakdown[].result_id and page_numbers to identify the result slice containing a page.

\n

Add run_id to inspect one run:

\n
\n
/outline?run_id=`, `59151131987041740000`)\"\n >\n
Copy
\n
Copied
\n
\n 
GET /document-store/documents/<document-id>/outline?run_id=<run-id>
\n
\n

Add result_id to inspect one result slice:

\n
\n
/outline?result_id=`, `51640898652838560000`)\"\n >\n
Copy
\n
Copied
\n
\n 
GET /document-store/documents/<document-id>/outline?result_id=<result-id>
\n
\n

Get one page

\n

Use GET /document-store/documents/{id}/pages/{page_number} to retrieve extracted text, key-value fields, and signatures for one page. Add result_id when the document contains multiple result slices.

\n

extracted_text_truncated indicates whether the returned page text reached the response limit.

\n

List key-value fields

\n

Retrieve key-value fields across the document:

\n

Use GET /document-store/documents/{id}/kv-fields.

\n

Available filters include:

\n\n

total reports the number of matches before pagination is applied.

\n

See Signatures for detected regions and structured signature results.

\n

Geometry

\n

Geometry uses normalized coordinates from 0 to 1, with the origin at the top-left:

\n\n

Multiply these values by the rendered page dimensions to draw an overlay.

\n

Geometry can be empty when a source format does not provide spatial coordinates. Build review interfaces that can still display the extracted value without a highlight.

\n

Page numbering

\n

Page numbers always refer to the uploaded parent document. A result created from pages 10–16 continues to use page numbers 10–16 rather than restarting at page 1.

\n

For a split document, first retrieve the outline and select the result whose page_numbers contains the requested page.

","headings":[{"value":"Inspecting Content","depth":1},{"value":"View content in Shipwell","depth":2},{"value":"Get the document outline","depth":2},{"value":"Get one page","depth":2},{"value":"List key-value fields","depth":2},{"value":"Geometry","depth":2},{"value":"Page numbering","depth":2}]},"contentItem":{"data":{"lastModified":"2026-07-17T16:00:10.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"80b7fab6-ab7a-5c5c-9cf4-5fcc928b2c3f__redocly content/docs/ai/document-ai/inspecting-document-content/","seo":{"title":"Inspecting Content","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"docs/ai/document-ai/inspecting-document-content.md","pageBaseUrl":"/docs/ai/document-ai/inspecting-document-content","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Inspecting Content","id":"inspecting-content"},{"depth":2,"value":"View content in Shipwell","id":"view-content-in-shipwell"},{"depth":2,"value":"Get the document outline","id":"get-the-document-outline"},{"depth":2,"value":"Get one page","id":"get-one-page"},{"depth":2,"value":"List key-value fields","id":"list-key-value-fields"},{"depth":2,"value":"Geometry","id":"geometry"},{"depth":2,"value":"Page numbering","id":"page-numbering"}]},"data":{"title":"Inspecting Content"},"catalogInfo":null,"link":"/docs/ai/document-ai/inspecting-document-content/","sidebarName":"developerPortal","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}