API Reference

Classify Documents

Classify a batch of one or multiple documents all at once by passing a list of document IDs, and an optional list of class IDs to use for classification. If no class IDs are provided, all classes will be used. To use the unknown class, either pass its classId ('unknown') or set the includeUnknown flag as True.

Body Params
documentIds
array of strings
required

List of document IDs to classify

Document IDs*
classIds
array of strings

List of class IDs to use for classification

Class IDs
boolean
Defaults to false

Whether to allow multiple classifications per document

boolean
Defaults to true

Whether to include the 'unknown' class in the classification (only relevant if multiClass is false)

string

Instructions for the AI on how to classify the documents

Responses

Response body
object
string
required

ID of the batch classification job

integer

Number of documents processed

integer

Number of pages processed

classificationJobIds
array of strings

List of individual job IDs for each document's classify job

Classification Job IDs
string
required

Status of the batch classification job

processing completed error

date-time

Timestamp of the classification job

Language
Credentials