> ## 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.
# List Classifications
> List classifications.
Returns a paginated list of classifications, most recent first. Filter by
`filename` or a `from_date`/`to_date` range, and page with `before`/`after`.
List persisted classifications for your organization, with id-based pagination.
```python Python theme={null}
from datetime import datetime
from retab import Retab
client = Retab()
classifications = client.classifications.list(limit=20, order="desc")
for c in classifications.data:
print(f"{c.id}: {c.output.category}")
# Filter by date range
classifications = client.classifications.list(
from_date=datetime(2024, 1, 1),
to_date=datetime(2024, 12, 31),
limit=50,
)
```
```typescript TypeScript theme={null}
import { Retab } from "@retab/node";
const client = new Retab({ apiKey: process.env.RETAB_API_KEY });
const classifications = await client.classifications.list({
limit: 20,
order: "desc",
});
for (const c of classifications.data) {
console.log(`${c.id}: ${c.output.category}`);
}
```
```go Go theme={null}
package main
import (
"context"
"fmt"
"log"
retab "github.com/retab-dev/retab/clients/go"
)
func ptr[T any](v T) *T { return &v }
func main() {
ctx := context.Background()
client, err := retab.NewClient("")
if err != nil {
log.Fatal(err)
}
classifications, err := client.Classifications.List(ctx, &retab.ClassificationsListParams{
PaginationParams: retab.PaginationParams{Limit: ptr(20), Order: ptr("desc")},
})
if err != nil {
log.Fatal(err)
}
for _, c := range classifications.Data {
fmt.Printf("%s: %s\n", c.ID, c.Output.Category)
}
}
```
```ruby Ruby theme={null}
require 'retab'
require 'date'
client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])
classifications = client.classifications.list(limit: 20, order: 'desc')
classifications.data.each do |c|
puts "#{c.id}: #{c.output.category}"
end
# Filter by date range
classifications = client.classifications.list(
from_date: DateTime.new(2024, 1, 1),
to_date: DateTime.new(2024, 12, 31),
limit: 50,
)
```
```rust Rust theme={null}
use retab::enums::ClassificationsOrder;
use retab::resources::classifications::ListParams;
use retab::Retab;
#[tokio::main]
async fn main() -> Result<(), Box> {
let client = Retab::new(std::env::var("RETAB_API_KEY")?);
let classifications = client
.classifications()
.list(ListParams {
limit: Some(20),
order: Some(ClassificationsOrder::Desc),
..Default::default()
})
.await?;
for c in &classifications.data {
println!("{}: {}", c.id, c.output.as_ref().unwrap().category);
}
// Filter by date range
let _ranged = client
.classifications()
.list(ListParams {
from_date: Some("2024-01-01".into()),
to_date: Some("2024-12-31".into()),
limit: Some(50),
..Default::default()
})
.await?;
Ok(())
}
```
```php PHP theme={null}
classifications()->list();
print_r($result);
```
```csharp C# theme={null}
using Retab;
using RetabClient = Retab.Retab;
var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);
var result = await client.Classifications.ListAsync(new ClassificationsListOptions());
Console.WriteLine(result);
```
```java Java theme={null}
import com.retab.RetabClient;
public final class Example {
public static void main(String[] args) throws Exception {
RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));
var result = client.classifications().list(null, null, 10L, null, "invoice.pdf", null, null, null);
System.out.println(result);
}
}
```
```curl cURL theme={null}
curl -X GET \
'https://api.retab.com/v1/classifications?limit=20&order=desc' \
-H "Authorization: Bearer $RETAB_API_KEY"
```
```json 200 theme={null}
{
"data": [
{
"id": "cls_01G34H8J2K",
"file": {
"id": "file_6dd6eb00688ad8d1",
"filename": "invoice.pdf",
"mime_type": "application/pdf"
},
"model": "retab-small",
"output": {
"category": "invoice",
"reasoning": "Contains line items and a total amount due."
},
"created_at": "2024-03-15T10:30:00Z"
}
],
"list_metadata": {
"before": null,
"after": "cls_01G34H8J2K",
"total_count": 42
}
}
```
## OpenAPI
````yaml GET /v1/classifications
openapi: 3.1.0
info:
title: FastAPI
version: 0.1.0
servers:
- url: https://api.retab.com
security: []
paths:
/v1/classifications:
get:
tags:
- Classifications
summary: List Classifications
description: >-
List classifications.
Returns a paginated list of classifications, most recent first. Filter
by
`filename` or a `from_date`/`to_date` range, and page with
`before`/`after`.
operationId: list_classifications
parameters:
- in: query
name: before
schema:
anyOf:
- type: string
- type: 'null'
title: Before
required: false
- in: query
name: after
schema:
anyOf:
- type: string
- type: 'null'
title: After
required: false
- in: query
name: limit
schema:
type: integer
maximum: 100
minimum: 1
default: 10
title: Limit
required: false
- in: query
name: order
schema:
enum:
- asc
- desc
type: string
default: desc
title: Order
required: false
- in: query
name: filename
schema:
anyOf:
- type: string
- type: 'null'
title: Filename
required: false
- in: query
name: status
schema:
anyOf:
- enum:
- pending
- queued
- in_progress
- completed
- failed
- cancelled
type: string
- type: 'null'
title: Status
required: false
- in: query
name: from_date
schema:
anyOf:
- type: string
- type: 'null'
title: From Date
required: false
- in: query
name: to_date
schema:
anyOf:
- type: string
- type: 'null'
title: To Date
required: false
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ClassificationList'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
ClassificationList:
description: >-
A page of `Classification` resources. `data` holds the items and
`list_metadata` carries the `before`/`after` cursors; pass `after` to
fetch the next page.
properties:
data:
items:
$ref: '#/components/schemas/Classification'
type: array
title: Data
list_metadata:
$ref: '#/components/schemas/ListMetadata'
type: object
required:
- data
- list_metadata
title: ClassificationList
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
default: []
type: object
title: HTTPValidationError
Classification:
properties:
id:
type: string
title: Id
description: Unique identifier of the classification
file:
$ref: '#/components/schemas/FileRef'
description: Information about the classified file
model:
type: string
title: Model
description: Model used for classification
categories:
items:
$ref: '#/components/schemas/Category'
type: array
title: Categories
description: Categories the document was classified against
n_consensus:
type: integer
title: N Consensus
description: Number of consensus votes used
default: 1
instructions:
anyOf:
- type: string
- type: 'null'
title: Instructions
description: Free-form instructions supplied with the classification request.
output:
$ref: '#/components/schemas/ClassificationDecision'
description: >-
The classification result with reasoning. A degenerate empty
decision until status == 'completed'; gate reads on status.
status:
type: string
enum:
- pending
- queued
- in_progress
- completed
- failed
- cancelled
title: Status
description: >-
Lifecycle status. The synchronous path returns 'completed'.
Background runs progress pending -> queued -> in_progress ->
completed | failed | cancelled.
default: pending
error:
anyOf:
- $ref: '#/components/schemas/PrimitiveError'
- type: 'null'
description: >-
Error details when a background run fails; null otherwise. Always
present so consumers can read it without an existence check.
consensus:
anyOf:
- $ref: '#/components/schemas/ClassificationConsensus'
- type: 'null'
description: Consensus metadata for multi-vote classification runs
usage:
anyOf:
- $ref: '#/components/schemas/RetabUsage'
- type: 'null'
description: Usage information for the classification
created_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created At
type: object
required:
- categories
- file
- id
- model
title: Classification
description: >-
A classification result: the categories a document was scored against
and the chosen `output` decision.
ListMetadata:
properties:
before:
anyOf:
- type: string
- type: 'null'
title: Before
after:
anyOf:
- type: string
- type: 'null'
title: After
type: object
required:
- after
- before
title: ListMetadata
description: Boundary resource IDs for page navigation.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
default: null
ctx:
type: object
title: Context
default: {}
type: object
required:
- loc
- msg
- type
title: ValidationError
FileRef:
properties:
id:
type: string
title: Id
description: ID of the file
filename:
type: string
title: Filename
description: Filename of the file
mime_type:
type: string
title: Mime Type
description: MIME type of the file
type: object
required:
- filename
- id
- mime_type
title: FileRef
description: Public/shared file reference used across SDK and customer-facing APIs.
Category:
properties:
name:
type: string
title: Name
description: The name of the category
handle_key:
anyOf:
- type: string
- type: 'null'
title: Handle Key
description: Stable machine key used by workflow classifier output handles
description:
type: string
title: Description
description: The description of the category
default: ''
type: object
required:
- name
title: Category
ClassificationDecision:
properties:
reasoning:
type: string
title: Reasoning
description: The reasoning for the classification decision
category:
type: string
title: Category
description: The category name that the document belongs to
type: object
required:
- category
- reasoning
title: ClassificationDecision
PrimitiveError:
properties:
code:
type: string
title: Code
description: Machine-readable error code.
message:
type: string
title: Message
description: Human-readable error message.
details:
anyOf:
- additionalProperties: true
type: object
- type: 'null'
title: Details
description: Optional structured error context.
type: object
required:
- code
- message
title: PrimitiveError
ClassificationConsensus:
properties:
choices:
items:
$ref: '#/components/schemas/ClassificationDecision'
type: array
title: Choices
description: >-
Alternative classification vote outputs used to build the
consolidated result.
default: []
likelihoods:
type: number
title: Likelihoods
description: Consensus likelihood score (0.0-1.0) of the winning classification.
default: 0
type: object
title: ClassificationConsensus
RetabUsage:
properties:
credits:
type: number
title: Credits
description: Credits consumed for processing
type: object
required:
- credits
title: RetabUsage
description: Usage information for document processing.
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
````