Skip to main content
POST
/
completion-messages
/
{task_id}
/
stop
Error
A valid request URL is required to generate request examples
{
  "result": "success"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with 'Bearer '. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

​
task_id
string
required

Task ID, can be obtained from the streaming chunk return of a /completion-messages request.

Body

application/json
​
user
string
required

User identifier, used to define the identity of the end-user, must be consistent with the user passed in the send message interface.

Response

200 - application/json

Stop request successful.

​
result
string
Example:

"success"