Create Split
Create a split.
Divides a document into the named subdocuments, assigning each its set of pages,
using the chosen model and optional instructions. Set n_consensus above 1 to
run multiple votes and consolidate them. Returns the stored Split with its output
page assignments, and responds with 201.
Split a multi-page document into labeled subdocuments and return the canonical split resource. This endpoint is split-only: key-based grouping belongs toDocumentation Index
Fetch the complete documentation index at: https://docs.retab.com/llms.txt
Use this file to discover all available pages before exploring further.
/v1/partitions.
Authorizations
Body
Request body to create a split.
A file represented by its filename and a base64 data url.
- MIMEData
- FileRef
The subdocuments to split the document into
The model to use to split the document
Free-form instructions appended to the system prompt to steer the split.
Number of consensus split runs to perform. Uses deterministic single-pass when set to 1.
If true, skip the LLM cache and force a fresh completion
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 split result: a document divided into its constituent subdocuments.
Unique identifier of the split result
Information about the split file
Model used for the split operation
Subdocuments used for the split operation
Number of consensus votes used
Free-form instructions supplied with the split request.
The list of document splits with their assigned pages. Empty [] until status == 'completed'.
Lifecycle status. The synchronous path returns 'completed'. Background runs progress pending -> queued -> in_progress -> completed | failed | cancelled.
pending, queued, in_progress, completed, failed, cancelled Error details when a background run fails; null otherwise. Always present so consumers can read it without an existence check.
Consensus metadata for multi-vote split runs
Usage information for the split operation