RealtimeClientEventConversationItemDelete interface

Send this event when you want to remove any item from the conversation history. The server will respond with a conversation.item.deleted event, unless the item does not exist in the conversation history, in which case the server will respond with an error.

Extends

Properties

event_id

Optional client-generated ID used to identify this event.

item_id

The ID of the item to delete.

type

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

Property Details

event_id

Optional client-generated ID used to identify this event.

event_id?: string

Property Value

string

item_id

The ID of the item to delete.

item_id: string

Property Value

string

type

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

type: "conversation.item.delete"

Property Value

"conversation.item.delete"