Stop Workflow Task
Available for: Workflow
Stops a running task.
Stopping is idempotent and tells you nothing about the task: stopping a task that has already finished, that does not exist, or that belongs to another API key also returns {"result": "success"}, without stopping anything.
Standard API equivalent: Stop Workflow Task. The contract is the same; only authentication and availability errors differ.
Authorizations
Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).
Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).
Path Parameters
Task ID, from the response or the streaming events of Run Workflow.
Body
End-user identifier, defined by your app and unique within it. Accepted for compatibility; the stop is authorized by the API key and task alone. See End User Identity.
Response
The stop was accepted.
Always success.