OpenAI API

ProjectUserListResponse

object
objectstringrequired
dataarray[object]required

Represents an individual user in a project.

Show Child Parameters
first_idstringrequired
last_idstringrequired
has_morebooleanrequired
Example

ProjectUserUpdateRequest

object
rolestringrequired

owner or member

Allowed values:ownermember

Example

RealtimeClientEventConversationItemCreate

object

Add a new Item to the Conversation’s context, including messages, function
calls, and function call responses. This event can be used both to populate a
“history” of the conversation and to add new items mid-stream, but has the
current limitation that it cannot populate assistant audio messages.

If successful, the server will respond with a conversation.item.created
event, otherwise an error event will be sent.

event_idstring

Optional client-generated ID used to identify this event.

typestringrequired

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

Allowed values:conversation.item.create

previous_item_idstring

The ID of the preceding item after which the new item will be inserted.
If not set, the new item will be appended to the end of the conversation.
If set to root, the new item will be added to the beginning of the conversation.
If set to an existing ID, it allows an item to be inserted mid-conversation. If the
ID cannot be found, an error will be returned and the item will not be added.

itemobjectrequired

The item to add to the conversation.

Show Child Parameters
Example

RealtimeClientEventConversationItemDelete

object

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.

event_idstring

Optional client-generated ID used to identify this event.

typestringrequired

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

Allowed values:conversation.item.delete

item_idstringrequired

The ID of the item to delete.

Example

RealtimeClientEventConversationItemTruncate

object

Send this event to truncate a previous assistant message’s audio. The server
will produce audio faster than realtime, so this event is useful when the user
interrupts to truncate audio that has already been sent to the client but not
yet played. This will synchronize the server’s understanding of the audio with
the client’s playback.

Truncating audio will delete the server-side text transcript to ensure there
is not text in the context that hasn’t been heard by the user.

If successful, the server will respond with a conversation.item.truncated
event.

event_idstring

Optional client-generated ID used to identify this event.

typestringrequired

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

Allowed values:conversation.item.truncate

item_idstringrequired

The ID of the assistant message item to truncate. Only assistant message
items can be truncated.

content_indexintegerrequired

The index of the content part to truncate. Set this to 0.

audio_end_msintegerrequired

Inclusive duration up to which audio is truncated, in milliseconds. If
the audio_end_ms is greater than the actual audio duration, the server
will respond with an error.

Example