Skip to main content
Cancel one workflow item

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required
item_id
string<uuid>
required

Response

The cancelled item.

id
string<uuid>
required
run_id
string<uuid>
required
retry_of_item_id
string<uuid> | null
required
label
string | null
required

The Document filename for document items; null otherwise.

resource
object
required
status
enum<string>
required
Available options:
queued,
running,
completed,
skipped,
failed,
cancelled
result
object
required

Immutable, bounded business result. null until completed or skipped; failed/cancelled items have no result.

failure
object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
started_at
string<date-time> | null
required
finished_at
string<date-time> | null
required