Completion Messages

Stop Completion Message Generation

Available for: Text Generator apps.

Stops a completion message generation task. Only supported in streaming mode.

post/completion-messages/{task_id}/stop

Request

  • Base URL
    https://api.dify.ai/v1
  • URL
    https://api.dify.ai/v1/completion-messages/{task_id}/stop
  • Auth
    HTTP bearer

Path parameters

task_idstring required

Task ID, from the streaming events of Send Completion Message.

Request body

userstring required

End-user identifier, defined by your app and unique within it. Must match the user sent with the original message; if it differs, the stop silently does nothing and still returns success. 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.