Cancel an in-flight automation run
Marks a queued, running, or waiting run as cancelled and returns it with its node executions. Requires the `automations:write` permission plus edit access to the automation; a run that has already finished is returned unchanged. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/workspaces/string/automations/string/runs/string/cancel"{ "data": { "id": "string", "automationId": "string", "automationVersionId": "string", "workspaceId": "string", "status": "queued", "source": "manual", "startedAt": "string", "completedAt": "string", "triggerPayload": {}, "output": {}, "error": "string", "metadata": {}, "startNodeId": "string", "replayOfRunId": "string", "nodeRuns": [ { "id": "string", "runId": "string", "nodeId": "string", "nodeKind": "string", "scopeKey": "string", "status": "queued", "attempt": 0, "input": {}, "output": {}, "error": "string", "startedAt": "string", "completedAt": "string" } ] }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Get a single automation run
Returns one run with its per-node executions. Requires the `automations:read` permission plus view access to the automation; an unknown automation or run returns not-found.
Retry a finished automation run
Queues a new run of the same automation version, reusing the original run's trigger payload and recording which run it retries. Requires the `automations:write` permission plus edit access; a run that has not finished yet is rejected with a run error. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.