Skip to main content
POST
Cancel an active chat completion

Path Parameters

completion_id
string
required

The ID of the chat completion to cancel

Response

The chat completion was cancelled successfully

Represents the cancellation confirmation of an active chat completion.

id
string
required

The ID of the cancelled chat completion.

object
enum<string>
required

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

Available options:
chat.completion.cancelled
cancelled
boolean
required

Whether the chat completion was successfully cancelled.

message
string

Additional information about the cancellation.