Skip to main content
POST
Request cancellation at a safe checkpoint with partial outcomes.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Bound to actor, operation, target, schema version and canonical payload; changed input returns 409.

Required string length: 8 - 255

Path Parameters

orgId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
id
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$

Response

Authorised operation result.

id
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
orgId
string
required
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
kind
string
required
operationId
string
required
state
enum<string>
required
Available options:
queued,
running,
succeeded,
failed,
cancelled,
partially_completed
createdAt
string
required
Pattern: ^(?!0000)\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}Z$
updatedAt
string
required
Pattern: ^(?!0000)\d{4}-\d{2}-\d{2}T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d\.\d{3}Z$
format
enum<string>
Available options:
csv,
jsonl
stage
string
databaseId
string
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
tableId
string
Pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
progress
object
result

Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.

error
object
checkpoint

Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.

attempt
integer
Required range: 0 <= x <= 9007199254740991