Skip to main content
POST
/
{key}
/
runs
/
{runId}
/
kill
Cancel a run
curl --request POST \
  --url https://api.trycordage.com/api/webhooks/{key}/runs/{runId}/kill \
  --header 'Authorization: Bearer <token>'
{
  "run_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "cancelled",
  "message": "Workflow cancelled"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Get your API key from the workspace settings.

Example: Authorization: Bearer cordage_xxxxxxxxxxxx

Path Parameters

​
key
string
required

The webhook key

Example:

"wh_abc123xyz"

​
runId
string<uuid>
required

The run ID to cancel

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Run cancelled successfully

​
run_id
string<uuid>
required

The cancelled run's ID

​
status
enum<string>
required

Always 'cancelled' for a successful kill

Available options:
cancelled
​
message
string
required

Human-readable status message