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.
RealtimeResponseCreateParams
objectCreate a new Realtime response with these parameters
The set of modalities the model can respond with. To disable audio,
set this to [“text”].
Allowed values:textaudio
The default system instructions (i.e. system message) prepended to model
calls. This field allows the client to guide the model on desired
responses. The model can be instructed on response content and format,
(e.g. “be extremely succinct”, “act friendly”, “here are examples of good
responses”) and on audio behavior (e.g. “talk quickly”, “inject emotion
into your voice”, “laugh frequently”). The instructions are not guaranteed
to be followed by the model, but they provide guidance to the model on the
desired behavior.
Note that the server sets default instructions which will be used if this
field is not set and are visible in the session.created event at the
start of the session.
The voice the model uses to respond. Voice cannot be changed during the
session once the model has responded with audio at least once. Current
voice options are alloy, ash, ballad, coral, echo sage,
shimmer and verse.
Allowed values:alloyashballadcoralechosageshimmerverse
The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw.
Allowed values:pcm16g711_ulawg711_alaw
Tools (functions) available to the model.
Show Child Parameters
How the model chooses tools. Options are auto, none, required, or
specify a function, like {"type": "function", "function": {"name": "my_function"}}.
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. Provide an integer between 1 and 4096 to
limit output tokens, or inf for the maximum available tokens for a
given model. Defaults to inf.
One OfControls which conversation the response is added to. Currently supports
auto and none, with auto as the default value. The auto value
means that the contents of the response will be added to the default
conversation. Set this to none to create an out-of-band response which
will not add items to default conversation.
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.
The item to add to the conversation.
Show Child Parameters
RealtimeServerEventConversationCreated
objectReturned when a conversation is created. Emitted right after session creation.
The unique ID of the server event.
The event type, must be conversation.created.
Allowed values:conversation.created
The conversation resource.
Show Child Parameters
RealtimeServerEventConversationItemCreated
objectReturned 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 typemessage
(roleassistant) or typefunction_call. - The input audio buffer has been committed, either by the client or the
server (inserver_vadmode). 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.createevent to add a new Item
to the Conversation.
The unique ID of the server event.
The event type, must be conversation.item.created.
Allowed values:conversation.item.created
The ID of the preceding item in the Conversation context, allows the
client to understand the order of the conversation.
The item to add to the conversation.