Cancel Partition

POST /v1/partitions/{partition_id}/cancel

Python

from retab import Retab

client = Retab()

partition = client.partitions.create_partition_cancel("prtn_01G34H8J2K")
print(partition.status)

200

{
  "id": "prtn_01G34H8J2K",
  "status": "cancelled",
  "error": null
}

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.

Python

from retab import Retab

client = Retab()

partition = client.partitions.create_partition_cancel("prtn_01G34H8J2K")
print(partition.status)

200

{
  "id": "prtn_01G34H8J2K",
  "status": "cancelled",
  "error": null
}

Authorizations

Api-Key · string · header · required

Path Parameters

partition_id · string · required

Response

200

application/json

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

Show child attributes

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'.

Show child attributes

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

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

Show child attributes

consensus · PartitionConsensus · object

Consensus metadata for multi-vote partition runs

Show child attributes

usage · RetabUsage · object

Usage information for the partition operation

Show child attributes

created_at · string<date-time> | null