documents

Get Document Layout

Changed on

Get the extracted layout of a document, with per-item page regions.

get/documents/{document_id}/layout

Request

  • Base URL
    https://extralit-public-demo.hf.space/api/v1
  • URL
    https://extralit-public-demo.hf.space/api/v1/documents/{document_id}/layout
  • Auth
    • API key in header X-Extralit-Api-Key
    • or HTTP bearer

Path parameters

document_idstring uuid required

Query parameters

pagesinteger[] nullable

1-indexed pages to include

labelsstring[] nullable

DocItemLabels to include, e.g. table

Response

Successful Response

document_idstring required

Document ID

docling_versionstring required

docling-core schema version of the stored document

num_itemsinteger required

Number of items in this response

num_pagesinteger required

Number of pages in this response

Changes