Skip to navigation

Cancel Run

Cancel an active workflow run.

Immediately marks the run as cancelled and stops any further processing. In-flight work at the current node may be abandoned mid-execution. The operation is idempotent: cancelling an already-cancelled run returns the run unchanged without error.

Runs already in a terminal state (completed, failed, or cancelled) are returned unchanged. Concurrent terminalization is also treated as an idempotent success; a still-active compare-and-swap loser returns 409.

Unlike pause, cancel is permanent — a cancelled run cannot be resumed. Use pause if you intend to continue the run later.

Requires at least editor role in the workspace; viewers cannot cancel runs.

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Path parameters

workflow_idstringRequiredformat: "uuid"
run_idstringRequiredformat: "uuid"

Headers

X-Workspace-Idstring or nullOptional

Response

Successful Response
dataobject
metaobject

Errors

422
Unprocessable Entity Error