Skip to navigation
APIsDocument Intelligence

Classify Document

View as Markdown

Creates a Classify job. Classify labels a document, or each page, against the categories you define, or suggests a document type when you supply none.

Input: send file (PDF, PNG, JPEG or TIFF; repeat the field for up to 10 documents) or upload_ids, plus a JSON request with the options below. You can also send a JSON body with input set to {"document_ref": "..."} to classify a child document returned by Split.

Processing: the job runs asynchronously. Poll GET /doc-ai/v1/job/{job_id}/status until it is completed, then fetch GET /doc-ai/v1/job/{job_id}/results. Add ?include=details to the results for inspected pages, provenance and evidence.

Review: review_required tells you whether a person should check the answer. confidence can be null; it is a token-based score, not a measured probability.

Authentication

api-subscription-keystring
API Key authentication via header

Headers

Idempotency-KeystringOptional

Retry the same submission without creating another job. The same key with the same request returns the original job (idempotency_replayed: true); the same key with a changed request returns 409 IDEMPOTENCY_CONFLICT.

Request

This endpoint expects a multipart form with multiple files.
filefilesOptional

Document file(s): PDF, PNG, JPEG or TIFF. Repeat the part for up to 10 documents with the same config.

upload_idsstringOptional

Comma-separated upload IDs returned by POST /doc-ai/v1/job/upload, with or instead of file.

requestobjectRequired

The JSON request part of a Classify submission.

Response

Job created. With request.execution set to auto, a single document that finishes in time instead returns 200 with the results object.

job_idstring
The unique identifier of the job. For a batch, the parent job.
statusstring

Initial status, accepted.

status_urlstring
Path to poll for status.
results_urlstring

Path to fetch results from once the job is completed.

run_idstringOptional
The unique identifier of the job run.
idempotency_replayedbooleanOptional

true when the response replays an earlier request with the same Idempotency-Key.

resolved_budgetmap from strings to anyOptional

Limits applied to the job, such as deadline_at and max_model_calls.

resolved_limitsobjectOptional
documentslist of objectsOptional

Batch submissions only: one entry per document, each with its own job.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error