Skip to navigation

Cancel Parse Job

Stops a running parse job, or deletes a finished job's result before it expires. A cancelled job is not billed.

Path parameters

job_idstringRequired

Headers

authorizationstringOptional

Response

The job after cancellation.
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