Sign in
Workflow Runs

Stop Workflow Task

Available for: Workflow apps.

Stop a running workflow task. Only supported in streaming mode.

post/workflows/tasks/{task_id}/stop

Path parameters

task_idstring required

Task ID, can be obtained from the streaming chunk return of the Run Workflow API.

Request body

userstring required

User identifier, used to attribute the stop request to an end user. It does not need to match the user passed to Run Workflow; the stop applies to the task regardless of user.

Response

Operation successful.

resultstring

Operation result. Always success.

Changes