Classify synchronously

Submit one document and receive its classification in the response.

POST /classify/sync returns the classification result on the same connection.

Requires the X-Api-Key header.

Request body

Send application/json using ClassifySyncRequest.

Property	Type	Description
content	string	Base64-encoded file content.
context	string	Additional context for classification.
custom_document_types	array	Restricts classification to these document types.
custom_document_types_url	string	URL to a JSON list of custom document types. Merges with custom_document_types.
entities	object	Entity ID-to-name mapping for Excel workbooks.
file_url	string	Public URL to the file.
metadata	object	Custom metadata.
model	string	Supported model: gpt-4.1, gpt-5.1, gemini-3, openrouter/z-ai/glm-5.2, or openrouter/deepseek/deepseek-v4-pro.
use_custom_types_only	boolean	Limits results to custom types. Requires custom types or their URL.

Responses

Status	Description	Schema
200	OK	ClassifySyncResponse
400	Bad Request	ValidationError
401	The API key is missing or invalid.
500	The request body is missing or invalid. Known defect.

Example

curl -X POST "https://<api-host>/classify/sync" \
  -H "X-Api-Key: $DOCAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
         "file_url": "https://example.com/unknown-document.pdf"
       }'