Bulk document classification

post

Authorizations

X-Api-KeystringRequired

Body

contextstring[] · nullableOptional

Per-file classification context strings. Length must match files array.

Default: null

custom_document_typesstring[] · nullableOptional

Custom document types applied to all files. If provided, classification is restricted to these types.

Default: null

custom_document_types_urlstring · nullableOptional

URL to custom document types JSON file. Merged with custom_document_types for all files.

Default: null

modelstring · enum · nullableOptional

LLM model for classification (applies to all files). Defaults to gemini-3 if not specified.

Default: nullExample: gemini-3Possible values:

use_custom_types_onlyboolean · nullableOptional

If true, only custom_document_types are valid. Applied to all files.

Default: false

Responses

200

OK

application/json

failedintegerRequired

Number of failed files

messagestring · nullableOptional

Status message

Default: null

statusstring · enumOptionalDefault: successPossible values:

successfulintegerRequired

Number of successfully classified files

totalintegerRequired

Total number of files submitted

400

Bad Request

application/json

401

Authentication required — the X-Api-Key header is missing or invalid.

post/classify/bulk

POST /classify/bulk HTTP/1.1
Host: api-docai-uat.uptiq.ai
X-Api-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 282

{
  "context": [
    "text"
  ],
  "custom_document_types": [
    "text"
  ],
  "custom_document_types_url": "text",
  "entities": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "files": [
    {
      "content": "text",
      "file_url": "text"
    }
  ],
  "metadata": [
    {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "model": "gemini-3",
  "use_custom_types_only": false
}

{
  "failed": 1,
  "message": "text",
  "results": [
    {
      "_id": "text",
      "error": "text",
      "index": 1,
      "requestId": "text",
      "status": "success",
      "storage": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "status": "success",
  "successful": 1,
  "total": 1
}