Skip to main content
POST
/
v1
/
edits
/
{edit_id}
/
cancel
from retab import Retab

client = Retab()

edit = client.edits.create_edit_cancel("edt_01G34H8J2K")
print(edit.status)

{
  "id": "edt_01G34H8J2K",
  "status": "cancelled",
  "error": null
}
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. 
from retab import Retab

client = Retab()

edit = client.edits.create_edit_cancel("edt_01G34H8J2K")
print(edit.status)

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

Authorizations

​
Api-Key
string
header
required

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

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

Durable file reference for the filled document, when materialized.

​
usage
RetabUsage · object

Usage information for the edit operation.

​
created_at
string<date-time> | null