Skip to main content
POST
/
v2
/
workflow
/
steps
/
cancel
Cancel Step
curl --request POST \
  --url https://api.velt.dev/v2/workflow/steps/cancel \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "executionId": "<string>",
    "stepId": "<string>",
    "reason": "<string>",
    "actorId": "<string>"
  }
}
'
{
  "result": {
    "cancelled": true,
    "stepId": "step_agent-draft_..._lwofay__to__human-brand"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.velt.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use this API to admin-cancel a specific step. The step transitions to cancelled, no downstream edges fire from it, and a step.cancelled event is emitted.

​
Endpoint

POST https://api.velt.dev/v2/workflow/steps/cancel

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

​
Params

​
data
object
required
Requires an admin-scoped auth token. Non-admin tokens are rejected with PERMISSION_DENIED.

​
Example Requests

​
Admin-cancel a step

{
  "data": {
    "executionId": "exec_1777374504255_xzy43k9q",
    "stepId": "step_agent-draft_..._lwofay__to__human-brand",
    "reason": "Reviewer unavailable",
    "actorId": "admin_jane"
  }
}

​
Response

​
Success Response

{
  "result": {
    "cancelled": true,
    "stepId": "step_agent-draft_..._lwofay__to__human-brand"
  }
}

​
Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "PERMISSION_DENIED"
  }
}
Errors: FAILED_PRECONDITION (step already terminal) / PERMISSION_DENIED / NOT_FOUND. 
{
  "result": {
    "cancelled": true,
    "stepId": "step_agent-draft_..._lwofay__to__human-brand"
  }
}