RealtimeClientEventResponseCreate
objectThis 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.
Optional client-generated ID used to identify this event.
The event type, must be response.create.
Allowed values:response.create
Create a new Realtime response with these parameters
Show Child Parameters
RealtimeClientEventSessionUpdate
objectSend 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.
Optional client-generated ID used to identify this event.
The event type, must be session.update.
Allowed values:session.update
Realtime session object configuration.
Show Child Parameters
RealtimeConversationItem
objectThe item to add to the conversation.
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.
The type of the item (message, function_call, function_call_output).
Allowed values:messagefunction_callfunction_call_output
Identifier for the API object being returned - always realtime.item.
Allowed values:realtime.item
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
The role of the message sender (user, assistant, system), only
applicable for message items.
Allowed values:userassistantsystem
The content of the message, applicable for message items.
- Message items of role
systemsupport onlyinput_textcontent - Message items of role
usersupportinput_textandinput_audio
content - Message items of role
assistantsupporttextcontent.
Show Child Parameters
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.
The name of the function being called (for function_call items).
The arguments of the function call (for function_call items).
The output of the function call (for function_call_output items).
RealtimeConversationItemWithReference
objectThe item to add to the conversation.
For an item of type (message | function_call | function_call_output)
this field allows the client to assign the unique ID of the item. It is
not required because the server will generate one if not provided.
For an item of type item_reference, this field is required and is a
reference to any item that has previously existed in the conversation.
The type of the item (message, function_call, function_call_output, item_reference).
Allowed values:messagefunction_callfunction_call_output
Identifier for the API object being returned - always realtime.item.
Allowed values:realtime.item
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
The role of the message sender (user, assistant, system), only
applicable for message items.
Allowed values:userassistantsystem
The content of the message, applicable for message items.
- Message items of role
systemsupport onlyinput_textcontent - Message items of role
usersupportinput_textandinput_audio
content - Message items of role
assistantsupporttextcontent.
Show Child Parameters
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.
The name of the function being called (for function_call items).
The arguments of the function call (for function_call items).
The output of the function call (for function_call_output items).
RealtimeResponse
objectThe response resource.
The unique ID of the response.
The object type, must be realtime.response.
Allowed values:realtime.response
The final status of the response (completed, cancelled, failed, or
incomplete).
Allowed values:completedcancelledfailedincomplete
Additional details about the status.
Show Child Parameters
The item to add to the conversation.
Show Child Parameters
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
Usage statistics for the Response, this will correspond to billing. A
Realtime API session will maintain a conversation context and append new
Items to the Conversation, thus output from previous turns (text and
audio tokens) will become the input for later turns.
Show Child Parameters
Which conversation the response is added to, determined by the conversation
field in the response.create event. If auto, the response will be added to
the default conversation and the value of conversation_id will be an id like
conv_1234. If none, the response will not be added to any conversation and
the value of conversation_id will be null. If responses are being triggered
by server VAD, the response will be added to the default conversation, thus
the conversation_id will be an id like conv_1234.
The voice the model used to respond.
Current voice options are alloy, ash, ballad, coral, echo sage,
shimmer and verse.
Allowed values:alloyashballadcoralechosageshimmerverse
The set of modalities the model used to respond. If there are multiple modalities,
the model will pick one, for example if modalities is ["text", "audio"], the model
could be responding in either text or audio.
Allowed values:textaudio
The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw.
Allowed values:pcm16g711_ulawg711_alaw
Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.
One OfMaximum number of output tokens for a single assistant response,
inclusive of tool calls, that was used in this response.