Interface ResponseOutputItemAddedEvent

Returned when a new Item is created during Response generation.

interface ResponseOutputItemAddedEvent {
    event_id: string;
    item: ConversationItem;
    output_index: number;
    response_id: string;
    type: "response.output_item.added";
}

Properties

event_id: string

The unique ID of the server event.

The item to add to the conversation.

output_index: number

The index of the output item in the Response.

response_id: string

The ID of the Response to which the item belongs.

type: "response.output_item.added"

The event type, must be response.output_item.added.