Interface ConversationItemCreatedEvent

Returned when a conversation item is created. There are several scenarios that produce this event:

  • The server is generating a Response, which if successful will produce either one or two Items, which will be of type message (role assistant) or type function_call.
  • The input audio buffer has been committed, either by the client or the server (in server_vad mode). The server will take the content of the input audio buffer and add it to a new user message Item.
  • The client has sent a conversation.item.create event to add a new Item to the Conversation.
interface ConversationItemCreatedEvent {
    event_id: string;
    item: ConversationItem;
    previous_item_id?: null | string;
    type: "conversation.item.created";
}

Properties

event_id item previous_item_id? type

Properties

event_id

event_id: string

The unique ID of the server event.

item

item: ConversationItem

The item to add to the conversation.

Optionalprevious_item_id

previous_item_id?: null | string

The ID of the preceding item in the Conversation context, allows the client to understand the order of the conversation. Can be null if the item has no predecessor.

type

type: "conversation.item.created"

The event type, must be conversation.item.created.

Settings

Member Visibility

On This Page

Properties