Skip to main content
POST
Best-effort cancel of a running or queued workflow run
Best-effort. A step already in flight with a provider is not clawed back — the run stops at the next boundary it can, and the work already done is still charged.

Authorizations

Authorization
string
header
required

API key in format: Bearer inf_***

Path Parameters

id
string
required

Run UUID.

Example:

"3c9a7e51-8b24-4f0d-9a17-6e2b5c4d8a03"

Response

The run's status after the call — cancelled, or the terminal status it already had.

id
string
required

The run the cancel was addressed to.

Example:

"3c9a7e51-8b24-4f0d-9a17-6e2b5c4d8a03"

status
enum<string>
required

cancelled when this call moved the run. For a run that was ALREADY terminal the call is a no-op and this echoes the status it already had — so a succeeded here means the run finished before the cancel reached it, not that cancelling succeeded.

Available options:
succeeded,
failed,
cancelled
Example:

"cancelled"