Cancel Async Chat Stream

curl --request POST \
  --url https://{base_url}/gpt/v1/messages/async/{message_id}/cancel \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "message": "Stream cancelled successfully",
  "message_id": "msg_async_12345"
}

Cancel Async Chat Stream

Cancel an active asynchronous chat stream.

This endpoint gracefully cancels an ongoing chat completion stream by:

Setting the cancellation token to stop the event generation loop
Cancelling the underlying asyncio task
Updating the stream status to ‘cancelled’

Notes:

Cancellation is irreversible - stream cannot be resumed
Any active SSE connections will receive a final event and close
Stream status will be updated to reflect cancellation
Use DELETE endpoint to remove cancelled streams from storage

POST

messages

async

{message_id}

cancel

Cancel Async Chat Stream

curl --request POST \
  --url https://{base_url}/gpt/v1/messages/async/{message_id}/cancel \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "message": "Stream cancelled successfully",
  "message_id": "msg_async_12345"
}

Path Parameters

message_id

string

required

Message ID of the asynchronous chat stream to cancel.

Body

application/json

Empty request body for stream cancellation. No additional parameters are required to cancel a stream.

The body is of type object.

Response

Stream cancelled successfully

Response model for cancelled asynchronous chat streams

message

string

required

Confirmation message for successful stream cancellation

message_id

string

required

Unique identifier of the cancelled stream

Get Async Chat Stream Status

Delete Async Chat Stream

⌘I

API Documentation

Tools

Examples

ZylonGPT API

Workspace API

Cancel Async Chat Stream

Path Parameters

Body

Response