Dify Octri Demo
POST/workflows/tasks/{task_id}/stop

Stop Workflow Task

Available for: Workflow apps.

Stop a running workflow task. Only supported in streaming mode, or after a blocking call returns with the run paused.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
task_idstringrequired
Task ID, from the streaming events of [Run Workflow](/en/api-reference/workflow-runs/run-workflow).
userstringrequired
End-user identifier, defined by your app and unique within it. Need not match the `user` that started the run; the stop applies to the task regardless of `user`. See [End User Identity](/en/api-reference/guides/end-user-identity).

2 status codes
200Operation successful.
resultstringoptional
Operation result. Always `success`.
400- `not_workflow_app` : App mode does not match the API route. - `invalid_param` : A request parameter is missing or invalid, such as a missing `user`.

2 documented failures

  • invalid_param

    Arg user must be provided.

    invalid_param

  • not_workflow_app

    Please check if your app mode matches the right API route.

    not_workflow_app

Error handling

A 400 is returned: - not_workflow_app : App mode does not match the API route.

  • invalid_param : A request parameter is missing or invalid, such as a missing user.