Skip to main content
POST
Cancel an in-flight background Partition run (one created with background: true). Cancellation is idempotent: a run that has already reached a terminal state (completed, failed, or cancelled) is returned unchanged rather than erroring.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

partition_id
string
required

Response

Successful Response

A partition result: a document segmented into chunks along the requested key.

id
string
required

Unique identifier of the partition

file
FileRef · object
required

Information about the partitioned file

model
string
required

Model used for the partition operation

key
string
required

Partition key used for the run

instructions
string | null

Free-form instructions supplied with the partition request

n_consensus
integer
default:1

Number of consensus votes used

allow_overlap
boolean
default:true

Whether pages were allowed to appear in more than one partition chunk

output
PartitionChunk · object[]

The list of partition chunks with their assigned pages. Empty [] until status == 'completed'.

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 | null

Error details when a background run fails; null otherwise. Always present so consumers can read it without an existence check.

consensus
PartitionConsensus · object | null

Consensus metadata for multi-vote partition runs

usage
RetabUsage · object | null

Usage information for the partition operation

created_at
string<date-time> | null