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
Path parameters
message_id
Message ID of the asynchronous chat stream to cancel.
Request
Empty request body for stream cancellation. No additional parameters are required to cancel a stream.
Response
Stream cancelled successfully
message
Confirmation message for successful stream cancellation
message_id
Unique identifier of the cancelled stream
Errors
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error

