Cancel Workflow
cancel_workflowCancel an active workflow by id. Cancelled workflows cannot be resumed and are excluded from resume_workflow's active listing; their record stays visible in list_workflows. Idempotent — cancelling an already-cancelled workflow returns the same result. If the gateway itself observed a lifecycle transport failure after the run started this month, cancellation restores the charged allowance under a bounded monthly safeguard.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"workflow_id": "<workflow_id>"
},
"name": "cancel_workflow"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| workflow_id | Yes | Id of the workflow run, as returned by start_workflow. Recover a lost id with list_workflows. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |