Classify

Run a saved Classifier against a document

Recommended for automation pipelines that reuse the same label set. The document must already be uploaded and OCR-processed.

post/v1/classifiers/{classifier_id}/classify

Request

  • Base URL: https://api.documentpro.ai
  • URL: https://api.documentpro.ai/v1/classifiers/{classifier_id}/classify
  • Auth: API key in header x-api-key

Path parameters

classifier_idstring uuid required

Request body

document_idstring uuid required
page_rangestring

Overrides the Classifier's default page range for this call only.

query_model'gpt-4o-mini' | 'gpt-4o'

Overrides the Classifier's default model for this call only.

Response

Classification result.

request_idstring uuid
document_idstring uuid
classifier_idstring uuid nullable

null for inline classification via POST /v1/classify.

classificationstring

The best-matching label.

confidence_scoresobject

Score 0.0-1.0 per label, summing to ~1.0.

request_status'completed' | 'failed' | 'exception'
credits_usedinteger
num_pagesinteger
durationnumber float

Seconds.

Changes

No recorded changes to this operation across all 1 revision of this API.