Flows · Runs · Stop a running workflow immediately and for good
Halts a running or paused execution at once and marks it TERMINATED.
Permanent. A terminated run cannot be resumed. In-flight tasks are abandoned rather than allowed to finish, so a task that has already caused an external side effect — a sent email, a published post — is not undone.
resource: workflow://run-control covers when to reach for this over pausing.
Authentication
AuthorizationApi-Key
Header authentication of the form Api-Key <token>
OR
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
run_id
UUID of a single workflow execution, from flows_startWorkflow
(returned as workflow_id) or flows_listWorkflowRuns (returned as
id). NOT the small integer workflow-definition ID.
Response
Run terminated. Empty body. Also returned when the run had already reached a terminal state, so terminating twice is safe.
Errors
400
Bad Request Error
404
Not Found Error