OpenAI API

RealtimeClientEventInputAudioBufferCommit

object

Send this event to commit the user input audio buffer, which will create a
new user message item in the conversation. This event will produce an error
if the input audio buffer is empty. When in Server VAD mode, the client does
not need to send this event, the server will commit the audio buffer
automatically.

Committing the input audio buffer will trigger input audio transcription
(if enabled in session configuration), but it will not create a response
from the model. The server will respond with an input_audio_buffer.committed
event.

event_idstring

Optional client-generated ID used to identify this event.

typestringrequired

The event type, must be input_audio_buffer.commit.

Allowed values:input_audio_buffer.commit

Example

RealtimeClientEventResponseCancel

object

Send this event to cancel an in-progress response. The server will respond
with a response.cancelled event or an error if there is no response to
cancel.

event_idstring

Optional client-generated ID used to identify this event.

typestringrequired

The event type, must be response.cancel.

Allowed values:response.cancel

response_idstring

A specific response ID to cancel - if not provided, will cancel an
in-progress response in the default conversation.

Example

RealtimeClientEventResponseCreate

object

This event instructs the server to create a Response, which means triggering
model inference. When in Server VAD mode, the server will create Responses
automatically.

A Response will include at least one Item, and may have two, in which case
the second will be a function call. These Items will be appended to the
conversation history.

The server will respond with a response.created event, events for Items
and content created, and finally a response.done event to indicate the
Response is complete.

The response.create event includes inference configuration like
instructions, and temperature. These fields will override the Session’s
configuration for this Response only.

event_idstring

Optional client-generated ID used to identify this event.

typestringrequired

The event type, must be response.create.

Allowed values:response.create

responseobject

Create a new Realtime response with these parameters

Show Child Parameters
Example

RealtimeClientEventSessionUpdate

object

Send this event to update the session’s default configuration. The client may
send this event at any time to update the session configuration, and any
field may be updated at any time, except for “voice”. The server will respond
with a session.updated event that shows the full effective configuration.
Only fields that are present are updated, thus the correct way to clear a
field like “instructions” is to pass an empty string.

event_idstring

Optional client-generated ID used to identify this event.

typestringrequired

The event type, must be session.update.

Allowed values:session.update

sessionobjectrequired

Realtime session object configuration.

Show Child Parameters
Example

RealtimeConversationItem

object

The item to add to the conversation.

idstring

The unique ID of the item, this can be generated by the client to help
manage server-side context, but is not required because the server will
generate one if not provided.

typestring

The type of the item (message, function_call, function_call_output).

Allowed values:messagefunction_callfunction_call_output

objectstring

Identifier for the API object being returned - always realtime.item.

Allowed values:realtime.item

statusstring

The status of the item (completed, incomplete). These have no effect
on the conversation, but are accepted for consistency with the
conversation.item.created event.

Allowed values:completedincomplete

rolestring

The role of the message sender (user, assistant, system), only
applicable for message items.

Allowed values:userassistantsystem

contentarray[object]

The content of the message, applicable for message items.

  • Message items of role system support only input_text content
  • Message items of role user support input_text and input_audio
    content
  • Message items of role assistant support text content.
Show Child Parameters
call_idstring

The ID of the function call (for function_call and
function_call_output items). If passed on a function_call_output
item, the server will check that a function_call item with the same
ID exists in the conversation history.

namestring

The name of the function being called (for function_call items).

argumentsstring

The arguments of the function call (for function_call items).

outputstring

The output of the function call (for function_call_output items).

Example