Stop Converse Stream — POST /api/v1/converse/stop-stream

Use this endpoint to cancel a streaming response that is currently in progress. When a user navigates away, submits a new message, or explicitly stops generation, you can call this endpoint with the stream’s ID to halt output immediately. This prevents the server from continuing to generate tokens for a response that is no longer needed.

Request

POST https://app.botsify.com/api/v1/converse/stop-stream Authorization: Bearer token — include your token in the Authorization: Bearer <token> header.

Body Parameters

string

required

The unique identifier of the stream to interrupt. This ID is returned in the initial response when you start a streaming conversation via the Converse Stream or Chat Stream endpoints.

string

required

The unique key that identifies your bot. Must match the bot_key used when the stream was started.

Example

curl --request POST \
  --url "https://app.botsify.com/api/v1/converse/stop-stream" \
  --header "Authorization: Bearer <your_token>" \
  --header "Content-Type: application/json" \
  --data '{
    "stream_id": "stream_a1b2c3d4",
    "bot_key": "bot_abc123"
  }'

Response

A successful request returns 200 OK confirming that the stream has been stopped.

{
  "success": true,
  "stream_id": "stream_a1b2c3d4",
  "message": "Stream stopped successfully."
}

If the stream has already completed or the stream_id is not found, the API returns a 404 Not Found response:

{
  "success": false,
  "error": "Stream not found or already completed."
}

Authorization

Bots & Agents

Agent Versions

Messaging

Users & Analytics

WhatsApp

Stop Converse Stream — POST /api/v1/converse/stop-stream

Request

Body Parameters

Example

Response

​Request

​Body Parameters

​Example

​Response

Request

Body Parameters

Example

Response