Skip to navigation
APIsDocument Intelligence

Get Job Status

View as Markdown

Returns a job’s status and page-level usage.

Terminal statuses: completed, partially_completed, failed, rejected. Results and download URLs are only available after the job reaches a terminal status.

Authentication

api-subscription-keystring
API Key authentication via header

Path parameters

job_idstringRequired
The unique identifier of the job

Response

OK
job_idstring
The unique identifier of the job.
statusstring

Current status of the job. Terminal statuses: completed, partially_completed, failed, rejected.

usageobject
created_atstring
Job creation timestamp.
updated_atstring
Timestamp of the last job update.
pipelinestringOptional

Job pipeline: parse or extract. Classify and Split jobs report type instead.

typestringOptional

Job type. Present for Classify and Split jobs: classify or split.

phasestringOptional

Processing phase of a Classify or Split job, e.g. commit when finished.

progressmap from strings to anyOptional

Progress counters for a Classify or Split job, such as pages_read, pages_analyzed and pages_total_selected.

result_revisionintegerOptional
Revision of the result. Present for Classify and Split jobs.
run_idstringOptional
The unique identifier of the job run.
results_urlstringOptional
Path to fetch the results from.
documentslist of maps from strings to anyOptional

For a batch, one entry per submitted document with its own job_id, status and URLs.

Errors

404
Not Found Error