Create extract job
POST/v1/jobs/extract-jobs/
Create an extract job from an existing parse job.
Body
Sent as application/json.
parse_job_idstringRequiredPublic ID of the completed parse job to extract data from.
schemaobjectRequiredJSON extraction schema for the extract job.
extraction_complexitystringComplexity tier for the extraction: low, medium, or high.
Returns
200 with a JSON object.
Show response attributesHide response attributes
detailstringRequiredextract_jobobjectRequiredShow child attributesHide child attributes
job_idstringRequiredUnique job identifier.
nicknamestring or nullDisplay name you gave the job.
processing_statusstringRequiredWhere the job is in its lifecycle:
pending(received, being inspected),queued(accepted, waiting to be processed),processing,completed(the result can be downloaded) orfailed(the job'serroranderror_codesay why).completedandfailedare final.created_atstring or nullWhen the job was created.
updated_atstring or nullWhen the job last changed.
processing_time_secondsnumber or nullTime the job took to process, once it has finished.
credits_costnumberCredits charged for the job.
errorstring or nullWhy the job failed, when it did.
error_codestring or nullStable error code of a failed job, from the same vocabulary as API errors.
file_namestring or nullName of the uploaded file, when the job has one.
page_countinteger or nullPages in the document, once it has been inspected.
job_typestringRequiredinput_job_idstring or nullRequiredThe parse job this extraction reads from.
extraction_schemaobjectRequiredJSON schema that was applied.
extraction_complexitystringRequiredComplexity level the extraction ran with.
billable_unitstring or nullUnit the job is billed in:
page,char,cellorpixel.billable_quantityinteger or nullQuantity billed, in
billable_unit.
Errors
Every error has the same JSON body. See Errors for the error codes and when to retry.
400Bad Request401Unauthorized403Forbidden404Not Found409Conflict410Gone413Request Entity Too Large422Unprocessable Entity429Too Many Requests500Internal Server Error