Classify

Create Classify Job

POST/api/v2/classify

List Classify Jobs

GET/api/v2/classify

Get Classify Job

GET/api/v2/classify/{job_id}

ModelsExpand Collapse

ClassifyConfiguration = object { rules, mode }

Configuration for classification.

rules: array of object { description, type }

Classification rules to apply (at least one required)

description: string

Natural language description of what to classify

maxLength500

minLength10

type: string

Document type to assign when rule matches

maxLength50

minLength1

mode: optional "FAST"

Classification execution mode

ClassifyCreateRequest = object { configuration, configuration_id, file_id, 2 more }

Request to create a classify job.

configuration: optional ClassifyConfiguration { rules, mode }

Configuration for classification.

rules: array of object { description, type }

Classification rules to apply (at least one required)

description: string

Natural language description of what to classify

maxLength500

minLength10

type: string

Document type to assign when rule matches

maxLength50

minLength1

mode: optional "FAST"

Classification execution mode

configuration_id: optional string

Product configuration ID for reusable presets

file_id: optional string

File ID to classify

parse_job_id: optional string

Parse job ID to classify

transaction_id: optional string

Idempotency key scoped to the project

ClassifyResult = object { confidence, reasoning, type }

Result of classifying a document.

confidence: number

Confidence score (0.0-1.0)

maximum1

minimum0

reasoning: string

Explanation of classification decision

type: string

Document type that matches, or None