Sessions
ModelsExpand Collapse
SessionCreateResponse object { id, audio, expires_at, 10 more } A Realtime session configuration object.
A Realtime session configuration object.
audio: optional object { input, output } Configuration for input and output audio for the session.
Configuration for input and output audio for the session.
input: optional object { format, noise_reduction, transcription, turn_detection }
noise_reduction: optional object { type } Configuration for input audio noise reduction.
Configuration for input audio noise reduction.
Additional fields to include in server outputs.
item.input_audio_transcription.logprobs: Include logprobs for input audio transcription.
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.
max_output_tokens: optional number or "inf"Maximum 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.
Maximum 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.
output_modalities: optional array of "text" or "audio"The set of modalities the model can respond with. To disable audio,
set this to [“text”].
The set of modalities the model can respond with. To disable audio, set this to [“text”].
How the model chooses tools. Options are auto, none, required, or
specify a function.
Tools (functions) available to the model.
Tools (functions) available to the model.
tracing: optional "auto" or object { group_id, metadata, workflow_name } Configuration options for tracing. Set to null to disable tracing. Once
tracing is enabled for a session, the configuration cannot be modified.
auto will create a trace for the session with default values for the
workflow name, group id, and metadata.
Configuration options for tracing. Set to null to disable tracing. Once tracing is enabled for a session, the configuration cannot be modified.
auto will create a trace for the session with default values for the
workflow name, group id, and metadata.
TracingConfiguration object { group_id, metadata, workflow_name } Granular configuration for tracing.
Granular configuration for tracing.
turn_detection: optional object { prefix_padding_ms, silence_duration_ms, threshold, type } Configuration for turn detection. Can be set to null to turn off. Server
VAD means that the model will detect the start and end of speech based on
audio volume and respond at the end of user speech.
Configuration for turn detection. Can be set to null to turn off. Server
VAD means that the model will detect the start and end of speech based on
audio volume and respond at the end of user speech.
Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.
Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user.