Skip to main content
GET
Cancel a run

Authorizations

X-Auth
string
header
required

Service-to-service API key

Headers

X-Permission-Info
string

Required API key permission: valid (informational only -- enforced server-side)

Path Parameters

run_id
string<uuid>
required

UUID of the workflow run

Response

Run cancelled

Workflow run record (from WorkflowRunModel.to_dict())

id
string<uuid>

Run UUID

type
string

Workflow type (e.g., sage, sage-nc)

state
enum<string>

Current state of the workflow run:

  • queued -- created but not yet started
  • running -- actively executing steps
  • finished -- all steps completed successfully
  • failed -- a step failed or out-of-order transition
  • canceled -- manually cancelled
Available options:
queued,
running,
finished,
failed,
canceled
percent
integer

Progress percentage

Required range: 0 <= x <= 100
current_step
string | null

ID of the currently running step (null when ended)

started_at
string<date-time>

When the run was created

ended_at
string<date-time> | null

When the run ended (null if still running)

duration_ms
integer | null

Total run duration in milliseconds

number_of_steps
integer

Total number of steps in this run

result
object | null

Run result data

errors
object | null

Error details (e.g., {"message": "Run canceled"})

meta
object

Navigation metadata for the run