Skip to main content
GET
/
v1
/
splits
/
{split_id}
from retab import Retab

client = Retab()
split = client.splits.get("split_01G34H8J2K")
for sub in split.output:
    print(f"{sub.name}: pages {sub.pages}")
{
  "id": "split_01G34H8J2K",
  "organization_id": "org_abc123",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "invoice_batch.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "output": [
    {"name": "invoice", "pages": [1, 2, 3], "partitions": []},
    {"name": "receipt", "pages": [4, 5], "partitions": []}
  ],
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-15T10:30:00Z"
}
from retab import Retab

client = Retab()
split = client.splits.get("split_01G34H8J2K")
for sub in split.output:
    print(f"{sub.name}: pages {sub.pages}")
{
  "id": "split_01G34H8J2K",
  "organization_id": "org_abc123",
  "file": {
    "id": "file_6dd6eb00688ad8d1",
    "filename": "invoice_batch.pdf",
    "mime_type": "application/pdf"
  },
  "model": "retab-small",
  "output": [
    {"name": "invoice", "pages": [1, 2, 3], "partitions": []},
    {"name": "receipt", "pages": [4, 5], "partitions": []}
  ],
  "created_at": "2024-03-15T10:30:00Z",
  "updated_at": "2024-03-15T10:30:00Z"
}

Path Parameters

split_id
string
required
The unique identifier of the split to retrieve.

Authorizations

Api-Key
string
header
required

Path Parameters

split_id
string
required

Query Parameters

access_token
string | null

Response

Successful Response

Backend-internal split with organization scoping.

file
FileRef · object
required

Information about the split file

model
string
required

Model used for the split operation

subdocuments
Subdocument · object[]
required

Subdocuments used for the split operation

output
SplitResult · object[]
required

The list of document splits with their assigned pages

organization_id
string
required

Organization ID of the user or application

id
string

Unique identifier of the split

n_consensus
integer
default:1

Number of consensus votes used

context
string | null

Additional context supplied with the split request

consensus
SplitConsensus · object

Consensus metadata for multi-vote split runs

usage
RetabUsage · object

Usage information for the split operation

created_at
string<date-time>
updated_at
string<date-time>