Skip to navigation

Get Parse Job

Returns the status of a parse job and, once it completes, its chunks in order. Chunks are included in the response when the result is 1 MB or smaller. result_url always links to the full result, so large results and bulk loads into another database can read from it directly. There are two ways to wait for a job. Poll: call this endpoint every few seconds without wait, and each request returns the current status at once. Long poll: pass wait (up to 50 seconds), and each request returns as soon as the job ends or the wait runs out. Either way, repeat until status is completed, failed or cancelled. The parse.completed, parse.failed and parse.cancelled webhook events report the end without polling.

Path parameters

job_idstringRequired

Headers

authorizationstringOptional

Query parameters

waitintegerOptional0-50Defaults to 0
Seconds to hold the request while the job is still running, from 0 to 50. The response returns as soon as the job completes, fails or is cancelled, or when the wait runs out, whichever comes first. 0 returns the current status at once.

Response

The job.
job_idstring
typeenum
Allowed values:
statusenum
Allowed values:
created_atstringformat: "date-time"
fileobjectOptional
optionsobjectOptional
The options the job ran with. Credentials are never returned.
chunker_versionstring or nullOptional
usageobjectOptional

What this job was billed, at the same rates as indexing. Documents bill per page. Spreadsheets bill no pages: their credits come from the sheet text and any described images.

chunk_countinteger or nullOptional
chunkslist of objects or nullOptional

The chunks, in order, when the result is 1 MB or smaller. Larger results are returned only through result_url.

result_urlstring or nullOptional
result_expires_atstring or nullOptionalformat: "date-time"
errorobject or nullOptional

Why the job failed. Present when status is failed. A failed job is not billed.

completed_atstring or nullOptionalformat: "date-time"

Errors

401
Unauthorized Error
404
Not Found Error