Skip to main content
post/completion-messages/{task_id}/stop
Request example
Response
post/completion-messages/{task_id}/stop

Authorization

Authorizationstringheaderrequired#

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path parameters

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

Body

application/json
userstringrequired#
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.

Responses

application/json
Operation successful.
resultstring#
Operation result. Always success.