Cancel Workflow

Cancel a specific workflow tool call within an execution.

This cancels only the workflow, allowing the agent to continue running and respond to the user about the cancellation. This is different from /cancel which stops the entire execution.

Args: execution_id: The agent execution ID workflow_message_id: The unique workflow message ID to cancel

POST /api/v1/executions/{execution_id}/cancel_workflow

Cancel Workflow

cURL

curl --request POST \
  --url https://control-plane.kubiya.ai/api/v1/executions/{execution_id}/cancel_workflow \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workflow_message_id": "<string>"
}
'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Enter your Kubiya API token (format: Bearer )

Path Parameters

execution_id · string · required

Body

application/json

Request to cancel a specific workflow

workflow_message_id · string · required

Response

200

application/json

Successful Response