Stop Agent App Message Generation

Stop a running Agent app streaming task.

POST /chat-messages/{task_id}/stop

Stop Agent App Message Generation

cURL

curl --request POST \
  --url https://{api_base_url}/chat-messages/{task_id}/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "abc-123"
}
'

200

{
  "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 returned by the Send Agent App Message streaming response.

Body

application/json

user · string · required

User identifier, must be consistent with the user passed in the send message interface.

Response

200

application/json

Operation successful.

result · string

Result status.