Skip to main content
POST
Request cancellation of a parse or extraction job
Request cancellation of a queued or processing job. The response returns its current status; keep polling to confirm the outcome. Start with Parse your first document.

Authorizations

unstructured-api-key
string
header
required

Path Parameters

jobId
string
required

Identifies one piece of work, whichever path submitted it. The same id the blocking call returns.

Example:

"9eb6c914-02a5-4c5d-8490-a06476946a38"

Response

The current job state after the cancellation request.

A job's state, carrying parsed content as soon as it is available.

id
string
required

Identifies one piece of work, whichever path submitted it. The same id the blocking call returns.

Example:

"9eb6c914-02a5-4c5d-8490-a06476946a38"

status
enum<string>
required

Terminal values match the blocking call's own status values.

Available options:
queued,
processing,
failed,
completed,
completed_with_warnings,
cancelled
file_id
string | null
required

The authoritative source/input file ID. This is the ID accepted by GET /api/v2/upload/{fileId}, never a job ID, result artifact ID, storage key, or signed URL. Null for legacy or unassociated jobs.

filename
string | null

The document's original uploaded filename.

cancellation_requested
boolean
default:false

True after cancellation has been requested for this job.

source
object | null

The associated original uploaded source file, when known.

error
object | null

A machine-readable code and an actionable message.

result
object | null

Null until parsed content is available.