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

edit_id
string
required

Response

Successful Response

An edit result: form-field values written onto a document or template PDF.

id
string
required

Unique identifier of the edit.

file
FileRef · object
required

Information about the source file (input document or template PDF).

model
string
required

Model used for the edit operation.

config
EditConfig · object
required

Configuration used for the edit operation.

instructions
string | null

Free-form instructions supplied with the edit request.

template_id
string | null

Template id used when the edit was created from a template; null for direct-document edits.

output
EditResult · object

The edit result: filled form fields and the rendered PDF. An empty sentinel until status == 'completed'; gate reads on status.

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.

filled_document_ref
FileRef · object | null

Durable file reference for the filled document, when materialized.

usage
RetabUsage · object | null

Usage information for the edit operation.

created_at
string<date-time> | null