Sign in
Chat

Cancel an active chat completion

Cancels an actively executing chat completion by terminating the subprocess and rolling back session state.

post/v1/cancel/{completion_id}

Path parameters

completion_idstring required

The ID of the chat completion to cancel

Response

The chat completion was cancelled successfully

idstring required

The ID of the cancelled chat completion.

object'chat.completion.cancelled' required

The object type, which is always "chat.completion.cancelled".

cancelledboolean required

Whether the chat completion was successfully cancelled.

messagestring

Additional information about the cancellation.