Synchronous document classification

post

Authorizations

X-Api-KeystringRequired

Body

contentstring · nullableOptional

Base64-encoded file content

Default: null

contextstring · nullableOptional

Additional context to guide the classification

Default: null

custom_document_typesstring[] · nullableOptional

Custom document types to classify against. If provided, classification is restricted to these types.

Default: null

custom_document_types_urlstring · nullableOptional

URL to a JSON file containing custom document types. Merged with custom_document_types if both provided.

Default: null

file_urlstring · nullableOptional

Public URL to file

Default: null

modelstring · enum · nullableOptional

LLM model for classification. Must be one of the supported models.

Default: gemini-3Example: gemini-3Possible values:

use_custom_types_onlyboolean · nullableOptional

If true, only custom_document_types are valid classification results. Requires custom_document_types or custom_document_types_url to be provided.

Default: false

Responses

200

OK

application/json

_idstringRequired

Classification document ID

isZipFileboolean · nullableOptional

True if this is a ZIP archive with child documents

Default: null

requestIdstringRequired

Request ID

resultany of · nullableOptional

Classification result: single result for PDF/image, array for Excel, or array of child results for ZIP

Default: null

or

or

statusstring · enumOptionalDefault: successPossible values:

400

Bad Request

application/json

401

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

500

Returned instead of 400 when the request body is missing or invalid. Known defect — see the API Reference.

post/classify/sync

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

{
  "content": "text",
  "context": "text",
  "custom_document_types": [
    "text"
  ],
  "custom_document_types_url": "text",
  "entities": {
    "ent_001": "ABC Corp",
    "ent_002": "XYZ LLC"
  },
  "file_url": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "model": "gemini-3",
  "use_custom_types_only": false
}

{
  "_id": "text",
  "additionalClassifications": [
    {
      "category": "text",
      "confidence": 1,
      "entity": "text",
      "pageNumber": 1,
      "sheetName": "text",
      "type": "text"
    }
  ],
  "isZipFile": true,
  "requestId": "text",
  "result": {
    "category": "text",
    "confidence": 1,
    "entity": "text",
    "pageNumber": 1,
    "sheetName": "text",
    "type": "text"
  },
  "status": "success"
}