Workflow Runs

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.

post/workflows/tasks/{task_id}/stop

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/workflows/tasks/{task_id}/stop
  • Auth
    HTTP bearer

Path parameters

task_idstring required

Task ID, from the streaming events of Run Workflow, or from the blocking response of a run that paused.

Request body

userstring required

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.

Response

Operation successful.

resultstring

Operation result. Always success.

Changes

No recorded changes to this operation across all 17 revisions of this API.