Skip to main content
POST
Stop Completion Message Generation

Authorizations

Authorization
string
header
required

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_id
string
required

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

Body

application/json
user
string
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.

result
string

Operation result. Always success.