Create Partitions
Create a partition.
Groups the pages of a document into chunks by a partition key, guided by
instructions and the chosen model. Set n_consensus above 1 to run multiple
votes and consolidate them, and allow_overlap to let a page belong to more than one
chunk. Returns the stored Partition with its output chunks, and responds with 201.
invoice_number, policy_id, or claim_number.
Authorizations
Body
Public create-partition request body.
A file represented by its filename and a base64 data url.
- MIMEData
- FileRef
The key to partition the document by
Instructions describing how the document should be partitioned
The model to use for partitioning
Number of partitioning runs to use for consensus voting. Uses deterministic single-pass when set to 1.
If true, allow a page to appear in more than one partition chunk
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 partition result: a document segmented into chunks along the requested key.
Unique identifier of the partition
Information about the partitioned file
Model used for the partition operation
Partition key used for the run
Free-form instructions supplied with the partition request
Number of consensus votes used
Whether pages were allowed to appear in more than one partition chunk
The list of partition chunks 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 partition runs
Usage information for the partition operation