Create parse job
POST/v1/jobs/parse-jobs/
Create a parse job entry for document processing.
Body
Sent as multipart/form-data.
filefile or nullDocument to parse (localfile connector). Use 'files' for several.
filesarray of filesUpload up to 25 files in one request (localfile connector only). Mutually exclusive with 'file'.
nicknamestring or nullOptional nickname for easier job identification.
output_formatstring or nullOutput format for the result: 'txt', 'json', 'html', 'md', 'zip'
input_connectorstringWhere to read the document from: 'localfile' (upload) or 's3'.
input_connection_dataobject or nullConfiguration for the input connector. For localfile: leave empty.
Show child attributesHide child attributes
source_bucketstringS3 bucket that holds the source object(s).
source_path_inside_bucketstringSingle object key inside the bucket (mutually exclusive with source_paths).
source_pathsarray of stringsBulk object keys inside the bucket (mutually exclusive with source_path_inside_bucket).
output_connectorstring or nullWhere to deliver the result: 's3' (your bucket, see output_connection_data). Leave empty to download it from ByteIt.
output_connection_dataobject or nullConfiguration for the output connector.
Show child attributesHide child attributes
bucketstringDestination S3 bucket.
pathstringDestination key prefix or object path inside the bucket.
processing_optionsobject or nullProcessing options for the job.
Show child attributesHide child attributes
languagesarray of stringspage_rangestringimage_annotationsbooleanforce_image_annotationsbooleantable_enrichmentbooleanparse_typestringoutput_formatstring
queue_for_batchboolean or nullWhen true, the job is accepted and held in queued status instead of starting processing immediately.
Returns
200 with a JSON object.
Show response attributesHide response attributes
detailstringRequiredparse_jobobject or nullShow 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_typestringRequiredfile_sizeinteger or nullSize of the document in bytes.
output_formatstring or nullFormat of the parsed result.
processing_optionsobject or nullOptions the document was parsed with.
Show child attributesHide child attributes
languagesarray of stringspage_rangestringimage_annotationsbooleanforce_image_annotationsbooleantable_enrichmentbooleanparse_typestringoutput_formatstring
input_connectorstring or nullRequiredWhere the document came from:
localfile(uploaded) ors3.output_connectorstring or nullRequiredWhere the result is delivered:
localfile(download) ors3.billable_unitstring or nullUnit the job is billed in:
page,char,cellorpixel.billable_quantityinteger or nullQuantity billed, in
billable_unit.
countinteger or nullparse_jobsarray of objects or nullShow 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_typestringRequiredfile_sizeinteger or nullSize of the document in bytes.
output_formatstring or nullFormat of the parsed result.
processing_optionsobject or nullOptions the document was parsed with.
Show child attributesHide child attributes
languagesarray of stringspage_rangestringimage_annotationsbooleanforce_image_annotationsbooleantable_enrichmentbooleanparse_typestringoutput_formatstring
input_connectorstring or nullRequiredWhere the document came from:
localfile(uploaded) ors3.output_connectorstring or nullRequiredWhere the result is delivered:
localfile(download) ors3.billable_unitstring or nullUnit the job is billed in:
page,char,cellorpixel.billable_quantityinteger or nullQuantity billed, in
billable_unit.
failed_filesarray of objects or nullShow child attributesHide child attributes
file_namestringRequirederrorstringRequired
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