Cancel Execution

Cancel a running workflow execution. Only effective for executions that are still in progress.

POST/api/workflows/{id}/executions/{executionId}/cancel

Authorization

apiKey
X-API-Key<token>

Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.

In: header

Path Parameters

id*string

The unique identifier of the workflow.

executionId*string

The unique identifier of the execution to cancel.

Response Body

application/json

application/json

application/json

curl -X POST \  "https://www.sim.ai/api/workflows/{id}/executions/{executionId}/cancel" \  -H "X-API-Key: YOUR_API_KEY"
{
  "success": true,
  "executionId": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}