Create custom job
POST/v1/jobs/custom-jobs/
Run the custom processing set up for your account. Custom jobs are solutions built on the ByteIt platform for requirements beyond the standard parse, extract and classification jobs (a specific document family, output layout or business rule). Follow and download them like any other job with jobs; jobs.download_result can include the extra files a custom job produces. To get one for your needs, contact ByteIt.
Body
Sent as multipart/form-data.
filesarray of filesUpload up to 25 documents for one custom job.
schemaobject or nullOptional JSON extraction schema for the custom job.
user_promptstring or nullOptional user prompt appended to the custom job request.
nicknamestring or nullOptional nickname for easier job identification.
Returns
200 with a JSON object.
Show response attributesHide response attributes
detailstringRequiredcustom_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_typestringRequiredextraction_schemaobject or nullJSON schema the job extracted with, when it extracts data.
user_promptstring or nullInstructions you gave the job.
file_namesarray of stringsNames of the uploaded files, in upload order.
total_page_countinteger or nullPages across all uploaded files.
document_typesarray of stringsFile type of each uploaded file, in upload order.
has_extrasbooleanWhether an extras ZIP can be downloaded.
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