Sign in

v1

latestOpenAPI 3.1.02026-07-173384141.4 KB
parse

get/documents/v2/parse/{parse_id}

Path parameters

parse_idstring required

The public ID of the parse job

Query parameters

with_optionsboolean

Response

Parse result details

parse_idstring

The unique identifier for the parse job

This is the same as the value returned from the POST /documents/v2/parse endpoint.

dataset_idstring nullable

If the parse job was scheduled from a dataset, this field contains the dataset id.

This is the identifier used in URLs and API endpoints to refer to the dataset.

parsed_pages_countinteger

The number of pages that were parsed successfully.

This is the total number of pages that were successfully parsed in the document.

status'pending' | 'processing' | 'successful' | 'failure'
errorstring nullable

Error ocurred during any part of the parse execution.

This is only populated if the parse operation failed.

created_atstring

The date and time when the parse job was created.

The date is in RFC 3339 format.

This can be used to track when the parse job was initiated.

finished_atstring nullable

The date and time when the parse job was finished.

The date is in RFC 3339 format.

This can be undefined if the parse job is still in progress or pending.

labelsobject

Labels associated with the parse job.

These are the key-value, or json, pairs submitted with the parse request.

This can be used to categorize or tag the parse job for easier identification and filtering.

It can be undefined if no labels were provided in the request.

Example response

{
  "parse_id": "parse_abcd1234",
  "parsed_pages_count": 5,
  "labels": {
    "priority": "high",
    "source": "email"
  }
}