Skip to main content
GET
/
v1
/
classifications
/
{classification_id}
from retab import Retab

client = Retab()

classification = client.classifications.get("cls_01G34H8J2K")
print(classification.output.category)

{
  "id": "cls_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "invoice.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "categories": [
    { "name": "invoice", "description": "Invoice documents" },
    { "name": "receipt", "description": "Receipts" }
  ],
  "n_consensus": 1,
  "output": {
    "category": "invoice",
    "reasoning": "Contains invoice header, line items, and total due."
  },
  "consensus": {
    "choices": [],
    "likelihood": null
  },
  "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.

from retab import Retab

client = Retab()

classification = client.classifications.get("cls_01G34H8J2K")
print(classification.output.category)

{
  "id": "cls_01G34H8J2K",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "invoice.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "categories": [
    { "name": "invoice", "description": "Invoice documents" },
    { "name": "receipt", "description": "Receipts" }
  ],
  "n_consensus": 1,
  "output": {
    "category": "invoice",
    "reasoning": "Contains invoice header, line items, and total due."
  },
  "consensus": {
    "choices": [],
    "likelihood": null
  },
  "created_at": "2024-03-15T10:30:00Z"
}

Authorizations

​
Api-Key
string
header
required

Path Parameters

​
classification_id
string
required

Query Parameters

​
include_output
boolean
default:true

When false, returns a cheap status-only projection (no output), served from cache for in-flight background runs.

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