Interface ResponseCancelEvent

Send this event to cancel an in-progress response. The server will respond with a response.cancelled event or an error if there is no response to cancel.

interface ResponseCancelEvent {
    event_id?: string;
    response_id?: string;
    type: "response.cancel";
}

Properties

event_id? response_id? type

Properties

Optionalevent_id

event_id?: string

Optional client-generated ID used to identify this event.

Optionalresponse_id

response_id?: string

A specific response ID to cancel - if not provided, will cancel an in-progress response in the default conversation.

type

type: "response.cancel"

The event type, must be response.cancel.

Settings

Member Visibility

On This Page

Properties