document_layout
field contains a JSON representation of the chunks of the page/document, all in a property called pages
.
Each page is represented as an object with the following properties:
page_number
: The page number of the document.page_fragments
: An array of document elements, each with:
fragment_type
: The type of the fragment (e.g., text, image, table).bbox
: The bounding box of the fragment, represented as an object with x1
, y1
, x2
, and y2
coordinates.chunks
field contains an array of text chunks extracted from the document. Each chunk is an object with a property
called content
, which is the text content of the chunk. If a chunking strategy was specified during the parse request,
the text will be chunked accordingly.
structured_data
field contains a JSON object with every schema_name
you provided in the parse request as a key.
Each object in this array represents a structured data item extracted from the document, adhering to the specified schema.
For example, if you provided the following schema for an invoice:
structured_data
field will contain objects that match that schema, such as:
structured_data
field will be null
. This can happen if the document does not contain any text that matches the schema you provided.
failure
, the errors
field will contain an object with details about the error.
status
field will indicate the current state of the parse job. Possible values are:
pending
: The job is waiting to be processed.processing
: The job is currently being processed.successful
: The job has been successfully completed and the results are available.failure
: The job has failed, and the errors
field will contain details aboutsuccessful
state, you can access the structured_data
, chunks
and document_layout
fields.Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
The public ID of the parse job
Parse result details
The response is of type object
.