Returned when the model-generated audio is done. Also emitted when a Response is interrupted, incomplete, or cancelled.

interface ResponseAudioDoneEvent {
    content_index: number;
    event_id: string;
    item_id: string;
    output_index: number;
    response_id: string;
    type: "response.audio.done";
}

Properties

content_index: number

The index of the content part in the item's content array.

event_id: string

The unique ID of the server event.

item_id: string

The ID of the item.

output_index: number

The index of the output item in the response.

response_id: string

The ID of the response.

type: "response.audio.done"

The event type, must be response.audio.done.