Skip to main content
POST
/
v1
/
classifications
from retab import Retab

client = Retab()

classification = client.classifications.create(
    document="invoice.pdf",
    model="retab-small",
    categories=[
        {"name": "invoice", "description": "Invoice documents with billing information"},
        {"name": "receipt", "description": "Receipt documents for payments"},
        {"name": "contract", "description": "Legal contract documents"},
    ],
    first_n_pages=3,
    instructions="Processing batch from Q4 2024 vendor submissions",
    n_consensus=1,
)

print(f"Classification ID: {classification.id}")
print(f"Category: {classification.output.category}")
print(f"Reasoning: {classification.output.reasoning}")
{
  "id": "cls_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "invoice.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "categories": [
    {
      "name": "invoice",
      "description": "Invoice documents with billing information"
    },
    { "name": "receipt", "description": "Receipt documents for payments" },
    { "name": "contract", "description": "Legal contract documents" }
  ],
  "n_consensus": 1,
  "instructions": "Processing batch from Q4 2024 vendor submissions",
  "output": {
    "reasoning": "The document contains billing details including line items, unit prices, quantities, and a total amount due.",
    "category": "invoice"
  },
  "consensus": {
    "choices": [],
    "likelihood": null
  },
  "usage": {
    "prompt_tokens": 1500,
    "completion_tokens": 40,
    "total_tokens": 1540
  },
  "created_at": "2024-03-15T10:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

Classify a document into one of the provided categories and persist the result as a Classification resource that can later be retrieved via GET /v1/classifications/{classification_id} or listed via GET /v1/classifications.
from retab import Retab

client = Retab()

classification = client.classifications.create(
    document="invoice.pdf",
    model="retab-small",
    categories=[
        {"name": "invoice", "description": "Invoice documents with billing information"},
        {"name": "receipt", "description": "Receipt documents for payments"},
        {"name": "contract", "description": "Legal contract documents"},
    ],
    first_n_pages=3,
    instructions="Processing batch from Q4 2024 vendor submissions",
    n_consensus=1,
)

print(f"Classification ID: {classification.id}")
print(f"Category: {classification.output.category}")
print(f"Reasoning: {classification.output.reasoning}")
{
  "id": "cls_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "invoice.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "categories": [
    {
      "name": "invoice",
      "description": "Invoice documents with billing information"
    },
    { "name": "receipt", "description": "Receipt documents for payments" },
    { "name": "contract", "description": "Legal contract documents" }
  ],
  "n_consensus": 1,
  "instructions": "Processing batch from Q4 2024 vendor submissions",
  "output": {
    "reasoning": "The document contains billing details including line items, unit prices, quantities, and a total amount due.",
    "category": "invoice"
  },
  "consensus": {
    "choices": [],
    "likelihood": null
  },
  "usage": {
    "prompt_tokens": 1500,
    "completion_tokens": 40,
    "total_tokens": 1540
  },
  "created_at": "2024-03-15T10:30:00Z"
}

Authorizations

Api-Key
string
header
required

Body

application/json

Public create-classification request body.

document
MIMEData · object
required

A file represented by its filename and a base64 data url.

categories
Category · object[]
required

The categories to classify the document into

Minimum array length: 1
model
string
default:retab-small

The model to use for classification

first_n_pages
integer | null

Only use the first N pages of the document for classification. Useful for large documents where classification can be determined from early pages.

instructions
string | null

Free-form instructions appended to the system prompt to steer the classification.

n_consensus
integer
default:1

Number of classification runs to use for consensus voting. Uses deterministic single-pass when set to 1.

bust_cache
boolean
default:false

If true, skip the LLM cache and force a fresh completion

background
boolean
default:false

If true, run asynchronously: returns immediately with status 'queued' and an empty output. Poll GET /v1//{id} until status is terminal. Mutually exclusive with stream.

Response

Successful Response

A classification result: the categories a document was scored against and the chosen output decision.

id
string
required

Unique identifier of the classification

file
FileRef · object
required

Information about the classified file

model
string
required

Model used for classification

categories
Category · object[]
required

Categories the document was classified against

n_consensus
integer
default:1

Number of consensus votes used

instructions
string | null

Free-form instructions supplied with the classification request.

output
ClassificationDecision · object

The classification result with reasoning. A degenerate empty decision until status == 'completed'; gate reads on status.

status
enum<string>
default:pending

Lifecycle status. The synchronous path returns 'completed'. Background runs progress pending -> queued -> in_progress -> completed | failed | cancelled.

Available options:
pending,
queued,
in_progress,
completed,
failed,
cancelled
error
PrimitiveError · object

Error details when a background run fails; null otherwise. Always present so consumers can read it without an existence check.

consensus
ClassificationConsensus · object

Consensus metadata for multi-vote classification runs

usage
RetabUsage · object

Usage information for the classification

created_at
string<date-time> | null