Cancel Async Chat Stream | PrivateGPT

Cancel an active asynchronous chat stream. This endpoint gracefully cancels an ongoing chat completion stream by: 1. Setting the cancellation token to stop the event generation loop 2. Cancelling the underlying asyncio task 3. 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

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_idstringRequired

Message ID of the asynchronous chat stream to cancel.

Request

This endpoint expects an object.

Response

This endpoint returns an object.

messagestring

Confirmation message for successful stream cancellation

message_idstring

Unique identifier of the cancelled stream

Errors

401

Unauthorized

404

Not Found

422

Unprocessable Entity

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

Message ID of the asynchronous chat stream to cancel.

This endpoint expects an object.

This endpoint returns an object.

Confirmation message for successful stream cancellation

Unique identifier of the cancelled stream

$	curl -X POST https://host.com/v1/messages/async/message_id/cancel \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"message": "Stream cancelled successfully",
3	"message_id": "msg_async_12345"
4	}