Skip to main content
POST
Cancel a run

Authorizations

Authorization
string
header
required

Workspace API key created in Erstan Settings. Keys carry scopes (agents:list, agents:read, agents:write, agents:run, runs:read, tasks:execute, documents:read, documents:write, files:read, files:write). Agent access follows the key creator's current workspace, team, and agent permissions. Agent draft creation requires agents:write; update, validation, and publishing require both agents:read and agents:write; draft testing also requires agents:run. Keys with tasks:execute must include at least one allowed project or team (allowedProjectIds / allowedTeamIds); keys with document or file scopes must include at least one allowed team. Empty allowlists mean no access — the API fails closed.

Path Parameters

runId
string<uuid>
required

Run ID returned by POST /v1/public/agents/{agentId}/runs.

Response

Cancellation state, including idempotency and acknowledgement timestamps.

runId
string<uuid>
required
agentId
string
required
status
enum<string>
required
Available options:
cancelling,
cancelled,
completed,
failed
alreadyTerminal
boolean
required
alreadyRequested
boolean
required
cancelRequestedAt
string<date-time> | null
required
cancelledAt
string<date-time> | null
required