Create classification job
POST/v1/jobs/classification-jobs/
Create a user-requested classification job from an uploaded file.
Body
Sent as multipart/form-data.
filefileRequiredDocument to classify.
classesarray of objects or nullOptional list of {label, description} objects. When omitted, system default classes are used. When provided, only these classes are used.
Show child attributesHide child attributes
labelstringRequiredClass label returned by the classifier.
descriptionstringRequiredShort description of when this class applies.
nicknamestring or nullOptional nickname for easier job identification.
Returns
200 with a JSON object.
Show response attributesHide response attributes
detailstringRequiredclassification_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_typestringRequireddocument_classstring or nullMajority page label for the document, or 'mixed' when the vote ties.
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