Skip to main content
POST
Cancel an in-flight background Extraction 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

extraction_id
string
required

Response

Successful Response

A stored extraction record from the Retab API.

id
string
required

Unique identifier of the extraction

file
FileRef · object
required

Information about the extracted file

model
string
required

Model used for the extraction

json_schema
Json Schema · object
required

JSON schema used for the extraction

output
Output · object
required

The extracted structured data

n_consensus
integer
default:1

Number of consensus votes used

instructions
string | null

Free-form instructions supplied with the extraction request.

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
ExtractionConsensus · object | null

Consensus metadata for multi-vote extraction runs

metadata
Metadata · object | null
usage
RetabUsage · object | null

Usage information for the extraction

created_at
string<date-time> | null