Cancel Step

POST /v2/workflow/steps/cancel

Cancel Step

cURL

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,
    "executionId": "exec_1777374504255_xzy43k9q",
    "stepId": "step_agent-draft_..._lwofay__to__human-brand"
  }
}

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

Show properties

executionId · string · required

The execution containing the step.

stepId · string · required

The step to cancel.

reason · string

≤ 500 chars. Surfaced on the step.cancelled event.

actorId · string · required

1–256 chars. Identifier of the administrator initiating the cancellation. Recorded on the step.cancelled audit event.

Workspace-admin RBAC is post-GA. Today this endpoint gates on the standard x-velt-auth-token only. Until role-based access lands, restrict who can call /steps/cancel inside your own application.

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,
    "executionId": "exec_1777374504255_xzy43k9q",
    "stepId": "step_agent-draft_..._lwofay__to__human-brand"
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "FAILED_PRECONDITION"
  }
}

Errors: INVALID_ARGUMENT (schema validation) / FAILED_PRECONDITION (step already terminal) / NOT_FOUND.

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