PageIndex Tree Generation

Page Index Status

get/doc/{doc_id}

Request

  • Base URL: https://api.pageindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.pageindex.ai/doc/{doc_id}
  • Auth: none declared

Path parameters

doc_idstring required

Document ID

Query parameters

typestring

Result type. Use 'tree' for tree structure or 'ocr' for OCR results.

formatstring

Format for OCR results. Use 'page' for page-based results, 'node' for node-based results, or 'raw' for concatenated markdown.

summaryboolean

If True, add summary to the results.

include_imagesboolean

If True, include presigned URLs for images referenced in OCR results.

include_textboolean

If False, omit text fields from tree nodes. Only applies when type=tree.

Response

Successful Response

unknown required

Changes

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