Skip to content
API Reference
Realtime
Client Secrets

Create client secret

ClientSecretCreateResponse realtime().clientSecrets().create(ClientSecretCreateParamsparams = ClientSecretCreateParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
POST/realtime/client_secrets

Create a Realtime client secret with an associated session configuration.

ParametersExpand Collapse
ClientSecretCreateParams params
Optional<ExpiresAfter> expiresAfter

Configuration for the client secret expiration. Expiration refers to the time after which a client secret will no longer be valid for creating sessions. The session itself may continue after that time once started. A secret can be used to create multiple sessions until it expires.

Optional<Anchor> anchor

The anchor point for the client secret expiration, meaning that seconds will be added to the created_at time of the client secret to produce an expiration timestamp. Only created_at is currently supported.

Optional<Long> seconds

The number of seconds from the anchor point to the expiration. Select a value between 10 and 7200 (2 hours). This default to 600 seconds (10 minutes) if not specified.

minimum10
maximum7200
Optional<Session> session

Session configuration to use for the client secret. Choose either a realtime session or a transcription session.

class RealtimeSessionCreateRequest:

Realtime session object configuration.

JsonValue; type "realtime"constant"realtime"constant

The type of session to create. Always realtime for the Realtime API.

Optional<RealtimeAudioConfig> audio

Configuration for input and output audio.

Optional<RealtimeAudioConfigInput> input
Optional<RealtimeAudioFormats> format

The format of the input audio.

Accepts one of the following:
AudioPcm
Optional<Rate> rate

The sample rate of the audio. Always 24000.

Optional<Type> type

The audio format. Always audio/pcm.

AudioPcmu
Optional<Type> type

The audio format. Always audio/pcmu.

AudioPcma
Optional<Type> type

The audio format. Always audio/pcma.

Optional<NoiseReduction> noiseReduction

Configuration for input audio noise reduction. This can be set to null to turn off. Noise reduction filters audio added to the input audio buffer before it is sent to VAD and the model. Filtering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.

Optional<NoiseReductionType> type

Type of noise reduction. near_field is for close-talking microphones such as headphones, far_field is for far-field microphones such as laptop or conference room microphones.

Accepts one of the following:
NEAR_FIELD("near_field")
FAR_FIELD("far_field")
Optional<AudioTranscription> transcription

Configuration for input audio transcription, defaults to off and can be set to null to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through the /audio/transcriptions endpoint and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

Optional<String> language

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

Optional<Model> model

The model to use for transcription. Current options are whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribe, and gpt-4o-transcribe-diarize. Use gpt-4o-transcribe-diarize when you need diarization with speaker labels.

Accepts one of the following:
WHISPER_1("whisper-1")
GPT_4O_MINI_TRANSCRIBE("gpt-4o-mini-transcribe")
GPT_4O_MINI_TRANSCRIBE_2025_12_15("gpt-4o-mini-transcribe-2025-12-15")
GPT_4O_TRANSCRIBE("gpt-4o-transcribe")
GPT_4O_TRANSCRIBE_DIARIZE("gpt-4o-transcribe-diarize")
Optional<String> prompt

An optional text to guide the model's style or continue a previous audio segment. For whisper-1, the prompt is a list of keywords. For gpt-4o-transcribe models (excluding gpt-4o-transcribe-diarize), the prompt is a free text string, for example "expect words related to technology".

Optional<RealtimeAudioInputTurnDetection> turnDetection

Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to null to turn off, in which case the client must manually trigger model response.

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.

Semantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with "uhhm", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.

Accepts one of the following:
ServerVad
JsonValue; type "server_vad"constant"server_vad"constant

Type of turn detection, server_vad to turn on simple Server VAD.

Optional<Boolean> createResponse

Whether or not to automatically generate a response when a VAD stop event occurs. If interrupt_response is set to false this may fail to create a response if the model is already responding.

If both create_response and interrupt_response are set to false, the model will never respond automatically but VAD events will still be emitted.

Optional<Long> idleTimeoutMs

Optional timeout after which a model response will be triggered automatically. This is useful for situations in which a long pause from the user is unexpected, such as a phone call. The model will effectively prompt the user to continue the conversation based on the current context.

The timeout value will be applied after the last model response's audio has finished playing, i.e. it's set to the response.done time plus audio playback duration.

An input_audio_buffer.timeout_triggered event (plus events associated with the Response) will be emitted when the timeout is reached. Idle timeout is currently only supported for server_vad mode.

minimum5000
maximum30000
Optional<Boolean> interruptResponse

Whether or not to automatically interrupt (cancel) any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs. If true then the response will be cancelled, otherwise it will continue until complete.

If both create_response and interrupt_response are set to false, the model will never respond automatically but VAD events will still be emitted.

Optional<Long> prefixPaddingMs

Used only for server_vad mode. Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.

Optional<Long> silenceDurationMs

Used only for server_vad mode. 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.

Optional<Double> threshold

Used only for server_vad mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.

SemanticVad
JsonValue; type "semantic_vad"constant"semantic_vad"constant

Type of turn detection, semantic_vad to turn on Semantic VAD.

Optional<Boolean> createResponse

Whether or not to automatically generate a response when a VAD stop event occurs.

Optional<Eagerness> eagerness

Used only for semantic_vad mode. The eagerness of the model to respond. low will wait longer for the user to continue speaking, high will respond more quickly. auto is the default and is equivalent to medium. low, medium, and high have max timeouts of 8s, 4s, and 2s respectively.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Optional<Boolean> interruptResponse

Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs.

Optional<RealtimeAudioConfigOutput> output
Optional<RealtimeAudioFormats> format

The format of the output audio.

Accepts one of the following:
AudioPcm
Optional<Rate> rate

The sample rate of the audio. Always 24000.

Optional<Type> type

The audio format. Always audio/pcm.

AudioPcmu
Optional<Type> type

The audio format. Always audio/pcmu.

AudioPcma
Optional<Type> type

The audio format. Always audio/pcma.

Optional<Double> speed

The speed of the model's spoken response as a multiple of the original speed. 1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.

This parameter is a post-processing adjustment to the audio after it is generated, it's also possible to prompt the model to speak faster or slower.

maximum1.5
minimum0.25
Optional<Voice> voice

The voice the model uses to respond. Supported built-in voices are alloy, ash, ballad, coral, echo, sage, shimmer, verse, marin, and cedar. Voice cannot be changed during the session once the model has responded with audio at least once. We recommend marin and cedar for best quality.

Accepts one of the following:
ALLOY("alloy")
ASH("ash")
BALLAD("ballad")
CORAL("coral")
ECHO("echo")
SAGE("sage")
SHIMMER("shimmer")
VERSE("verse")
MARIN("marin")
CEDAR("cedar")
Optional<List<Include>> include

Additional fields to include in server outputs.

item.input_audio_transcription.logprobs: Include logprobs for input audio transcription.

Optional<String> instructions

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.

Optional<MaxOutputTokens> maxOutputTokens

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.

Accepts one of the following:
long
JsonValue;
Optional<Model> model

The Realtime model used for this session.

Accepts one of the following:
GPT_REALTIME("gpt-realtime")
GPT_REALTIME_2025_08_28("gpt-realtime-2025-08-28")
GPT_4O_REALTIME_PREVIEW("gpt-4o-realtime-preview")
GPT_4O_REALTIME_PREVIEW_2024_10_01("gpt-4o-realtime-preview-2024-10-01")
GPT_4O_REALTIME_PREVIEW_2024_12_17("gpt-4o-realtime-preview-2024-12-17")
GPT_4O_REALTIME_PREVIEW_2025_06_03("gpt-4o-realtime-preview-2025-06-03")
GPT_4O_MINI_REALTIME_PREVIEW("gpt-4o-mini-realtime-preview")
GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17("gpt-4o-mini-realtime-preview-2024-12-17")
GPT_REALTIME_MINI("gpt-realtime-mini")
GPT_REALTIME_MINI_2025_10_06("gpt-realtime-mini-2025-10-06")
GPT_REALTIME_MINI_2025_12_15("gpt-realtime-mini-2025-12-15")
GPT_AUDIO_MINI("gpt-audio-mini")
GPT_AUDIO_MINI_2025_10_06("gpt-audio-mini-2025-10-06")
GPT_AUDIO_MINI_2025_12_15("gpt-audio-mini-2025-12-15")
Optional<List<OutputModality>> outputModalities

The set of modalities the model can respond with. It defaults to ["audio"], indicating that the model will respond with audio plus a transcript. ["text"] can be used to make the model respond with text only. It is not possible to request both text and audio at the same time.

Accepts one of the following:
TEXT("text")
AUDIO("audio")
Optional<ResponsePrompt> prompt

Reference to a prompt template and its variables. Learn more.

String id

The unique identifier of the prompt template to use.

Optional<Variables> variables

Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

Accepts one of the following:
String
class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

An image input to the model. Learn about image inputs.

Detail detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

Accepts one of the following:
LOW("low")
HIGH("high")
AUTO("auto")
JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

The ID of the file to be sent to the model.

Optional<String> imageUrl

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<String> fileData

The content of the file to be sent to the model.

Optional<String> fileId

The ID of the file to be sent to the model.

Optional<String> fileUrl

The URL of the file to be sent to the model.

Optional<String> filename

The name of the file to be sent to the model.

Optional<String> version

Optional version of the prompt template.

Optional<RealtimeToolChoiceConfig> toolChoice

How the model chooses tools. Provide one of the string modes or force a specific function/MCP tool.

Accepts one of the following:
enum ToolChoiceOptions:

Controls which (if any) tool is called by the model.

none means the model will not call any tool and instead generates a message.

auto means the model can pick between generating a message or calling one or more tools.

required means the model must call one or more tools.

NONE("none")
AUTO("auto")
REQUIRED("required")
class ToolChoiceFunction:

Use this option to force the model to call a specific function.

String name

The name of the function to call.

JsonValue; type "function"constant"function"constant

For function calling, the type is always function.

class ToolChoiceMcp:

Use this option to force the model to call a specific tool on a remote MCP server.

String serverLabel

The label of the MCP server to use.

JsonValue; type "mcp"constant"mcp"constant

For MCP tools, the type is always mcp.

Optional<String> name

The name of the tool to call on the server.

Optional<List<RealtimeToolsConfigUnion>> tools

Tools available to the model.

Accepts one of the following:
class RealtimeFunctionTool:
Optional<String> description

The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).

Optional<String> name

The name of the function.

Optional<JsonValue> parameters

Parameters of the function in JSON Schema.

Optional<Type> type

The type of the tool, i.e. function.

Mcp
String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

Accepts one of the following:
List<String>
class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

Currently supported connector_id values are:

  • Dropbox: connector_dropbox
  • Gmail: connector_gmail
  • Google Calendar: connector_googlecalendar
  • Google Drive: connector_googledrive
  • Microsoft Teams: connector_microsoftteams
  • Outlook Calendar: connector_outlookcalendar
  • Outlook Email: connector_outlookemail
  • SharePoint: connector_sharepoint
Accepts one of the following:
CONNECTOR_DROPBOX("connector_dropbox")
CONNECTOR_GMAIL("connector_gmail")
CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")
CONNECTOR_GOOGLEDRIVE("connector_googledrive")
CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")
CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")
CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")
CONNECTOR_SHAREPOINT("connector_sharepoint")
Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server's tools require approval.

Accepts one of the following:
class McpToolApprovalFilter:

Specify which of the MCP server's tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")
NEVER("never")
Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

Optional<RealtimeTracingConfig> tracing

Realtime API can write session traces to the Traces Dashboard. 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.

Accepts one of the following:
JsonValue;
TracingConfiguration
Optional<String> groupId

The group id to attach to this trace to enable filtering and grouping in the Traces Dashboard.

Optional<JsonValue> metadata

The arbitrary metadata to attach to this trace to enable filtering in the Traces Dashboard.

Optional<String> workflowName

The name of the workflow to attach to this trace. This is used to name the trace in the Traces Dashboard.

Optional<RealtimeTruncation> truncation

When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.

Clients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.

Truncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.

Truncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.

Accepts one of the following:
RealtimeTruncationStrategy
Accepts one of the following:
AUTO("auto")
DISABLED("disabled")
class RealtimeTruncationRetentionRatio:

Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.

double retentionRatio

Fraction of post-instruction conversation tokens to retain (0.0 - 1.0) when the conversation exceeds the input token limit. Setting this to 0.8 means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.

minimum0
maximum1
JsonValue; type "retention_ratio"constant"retention_ratio"constant

Use retention ratio truncation.

Optional<TokenLimits> tokenLimits

Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.

Optional<Long> postInstructions

Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.

minimum0
class RealtimeTranscriptionSessionCreateRequest:

Realtime transcription session object configuration.

JsonValue; type "transcription"constant"transcription"constant

The type of session to create. Always transcription for transcription sessions.

Optional<RealtimeTranscriptionSessionAudio> audio

Configuration for input and output audio.

Optional<RealtimeAudioFormats> format

The PCM audio format. Only a 24kHz sample rate is supported.

Accepts one of the following:
AudioPcm
Optional<Rate> rate

The sample rate of the audio. Always 24000.

Optional<Type> type

The audio format. Always audio/pcm.

AudioPcmu
Optional<Type> type

The audio format. Always audio/pcmu.

AudioPcma
Optional<Type> type

The audio format. Always audio/pcma.

Optional<NoiseReduction> noiseReduction

Configuration for input audio noise reduction. This can be set to null to turn off. Noise reduction filters audio added to the input audio buffer before it is sent to VAD and the model. Filtering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.

Optional<NoiseReductionType> type

Type of noise reduction. near_field is for close-talking microphones such as headphones, far_field is for far-field microphones such as laptop or conference room microphones.

Accepts one of the following:
NEAR_FIELD("near_field")
FAR_FIELD("far_field")
Optional<AudioTranscription> transcription

Configuration for input audio transcription, defaults to off and can be set to null to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through the /audio/transcriptions endpoint and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

Optional<String> language

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

Optional<Model> model

The model to use for transcription. Current options are whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribe, and gpt-4o-transcribe-diarize. Use gpt-4o-transcribe-diarize when you need diarization with speaker labels.

Accepts one of the following:
WHISPER_1("whisper-1")
GPT_4O_MINI_TRANSCRIBE("gpt-4o-mini-transcribe")
GPT_4O_MINI_TRANSCRIBE_2025_12_15("gpt-4o-mini-transcribe-2025-12-15")
GPT_4O_TRANSCRIBE("gpt-4o-transcribe")
GPT_4O_TRANSCRIBE_DIARIZE("gpt-4o-transcribe-diarize")
Optional<String> prompt

An optional text to guide the model's style or continue a previous audio segment. For whisper-1, the prompt is a list of keywords. For gpt-4o-transcribe models (excluding gpt-4o-transcribe-diarize), the prompt is a free text string, for example "expect words related to technology".

Optional<RealtimeTranscriptionSessionAudioInputTurnDetection> turnDetection

Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to null to turn off, in which case the client must manually trigger model response.

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.

Semantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with "uhhm", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.

Accepts one of the following:
ServerVad
JsonValue; type "server_vad"constant"server_vad"constant

Type of turn detection, server_vad to turn on simple Server VAD.

Optional<Boolean> createResponse

Whether or not to automatically generate a response when a VAD stop event occurs. If interrupt_response is set to false this may fail to create a response if the model is already responding.

If both create_response and interrupt_response are set to false, the model will never respond automatically but VAD events will still be emitted.

Optional<Long> idleTimeoutMs

Optional timeout after which a model response will be triggered automatically. This is useful for situations in which a long pause from the user is unexpected, such as a phone call. The model will effectively prompt the user to continue the conversation based on the current context.

The timeout value will be applied after the last model response's audio has finished playing, i.e. it's set to the response.done time plus audio playback duration.

An input_audio_buffer.timeout_triggered event (plus events associated with the Response) will be emitted when the timeout is reached. Idle timeout is currently only supported for server_vad mode.

minimum5000
maximum30000
Optional<Boolean> interruptResponse

Whether or not to automatically interrupt (cancel) any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs. If true then the response will be cancelled, otherwise it will continue until complete.

If both create_response and interrupt_response are set to false, the model will never respond automatically but VAD events will still be emitted.

Optional<Long> prefixPaddingMs

Used only for server_vad mode. Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.

Optional<Long> silenceDurationMs

Used only for server_vad mode. 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.

Optional<Double> threshold

Used only for server_vad mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.

SemanticVad
JsonValue; type "semantic_vad"constant"semantic_vad"constant

Type of turn detection, semantic_vad to turn on Semantic VAD.

Optional<Boolean> createResponse

Whether or not to automatically generate a response when a VAD stop event occurs.

Optional<Eagerness> eagerness

Used only for semantic_vad mode. The eagerness of the model to respond. low will wait longer for the user to continue speaking, high will respond more quickly. auto is the default and is equivalent to medium. low, medium, and high have max timeouts of 8s, 4s, and 2s respectively.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Optional<Boolean> interruptResponse

Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs.

Optional<List<Include>> include

Additional fields to include in server outputs.

item.input_audio_transcription.logprobs: Include logprobs for input audio transcription.

ReturnsExpand Collapse
class ClientSecretCreateResponse:

Response from creating a session and client secret for the Realtime API.

long expiresAt

Expiration timestamp for the client secret, in seconds since epoch.

Session session

The session configuration for either a realtime or transcription session.

Accepts one of the following:
class RealtimeSessionCreateResponse:

A new Realtime session configuration, with an ephemeral key. Default TTL for keys is one minute.

RealtimeSessionClientSecret clientSecret

Ephemeral key returned by the API.

long expiresAt

Timestamp for when the token expires. Currently, all tokens expire after one minute.

String value

Ephemeral key usable in client environments to authenticate connections to the Realtime API. Use this in client-side environments rather than a standard API token, which should only be used server-side.

JsonValue; type "realtime"constant"realtime"constant

The type of session to create. Always realtime for the Realtime API.

Optional<Audio> audio

Configuration for input and output audio.

Optional<Input> input
Optional<RealtimeAudioFormats> format

The format of the input audio.

Accepts one of the following:
AudioPcm
Optional<Rate> rate

The sample rate of the audio. Always 24000.

Optional<Type> type

The audio format. Always audio/pcm.

AudioPcmu
Optional<Type> type

The audio format. Always audio/pcmu.

AudioPcma
Optional<Type> type

The audio format. Always audio/pcma.

Optional<NoiseReduction> noiseReduction

Configuration for input audio noise reduction. This can be set to null to turn off. Noise reduction filters audio added to the input audio buffer before it is sent to VAD and the model. Filtering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.

Optional<NoiseReductionType> type

Type of noise reduction. near_field is for close-talking microphones such as headphones, far_field is for far-field microphones such as laptop or conference room microphones.

Accepts one of the following:
NEAR_FIELD("near_field")
FAR_FIELD("far_field")
Optional<AudioTranscription> transcription

Configuration for input audio transcription, defaults to off and can be set to null to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through the /audio/transcriptions endpoint and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.

Optional<String> language

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

Optional<Model> model

The model to use for transcription. Current options are whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribe, and gpt-4o-transcribe-diarize. Use gpt-4o-transcribe-diarize when you need diarization with speaker labels.

Accepts one of the following:
WHISPER_1("whisper-1")
GPT_4O_MINI_TRANSCRIBE("gpt-4o-mini-transcribe")
GPT_4O_MINI_TRANSCRIBE_2025_12_15("gpt-4o-mini-transcribe-2025-12-15")
GPT_4O_TRANSCRIBE("gpt-4o-transcribe")
GPT_4O_TRANSCRIBE_DIARIZE("gpt-4o-transcribe-diarize")
Optional<String> prompt

An optional text to guide the model's style or continue a previous audio segment. For whisper-1, the prompt is a list of keywords. For gpt-4o-transcribe models (excluding gpt-4o-transcribe-diarize), the prompt is a free text string, for example "expect words related to technology".

Optional<TurnDetection> turnDetection

Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to null to turn off, in which case the client must manually trigger model response.

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.

Semantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with "uhhm", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.

Accepts one of the following:
class ServerVad:

Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.

JsonValue; type "server_vad"constant"server_vad"constant

Type of turn detection, server_vad to turn on simple Server VAD.

Optional<Boolean> createResponse

Whether or not to automatically generate a response when a VAD stop event occurs. If interrupt_response is set to false this may fail to create a response if the model is already responding.

If both create_response and interrupt_response are set to false, the model will never respond automatically but VAD events will still be emitted.

Optional<Long> idleTimeoutMs

Optional timeout after which a model response will be triggered automatically. This is useful for situations in which a long pause from the user is unexpected, such as a phone call. The model will effectively prompt the user to continue the conversation based on the current context.

The timeout value will be applied after the last model response's audio has finished playing, i.e. it's set to the response.done time plus audio playback duration.

An input_audio_buffer.timeout_triggered event (plus events associated with the Response) will be emitted when the timeout is reached. Idle timeout is currently only supported for server_vad mode.

minimum5000
maximum30000
Optional<Boolean> interruptResponse

Whether or not to automatically interrupt (cancel) any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs. If true then the response will be cancelled, otherwise it will continue until complete.

If both create_response and interrupt_response are set to false, the model will never respond automatically but VAD events will still be emitted.

Optional<Long> prefixPaddingMs

Used only for server_vad mode. Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.

Optional<Long> silenceDurationMs

Used only for server_vad mode. 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.

Optional<Double> threshold

Used only for server_vad mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.

class SemanticVad:

Server-side semantic turn detection which uses a model to determine when the user has finished speaking.

JsonValue; type "semantic_vad"constant"semantic_vad"constant

Type of turn detection, semantic_vad to turn on Semantic VAD.

Optional<Boolean> createResponse

Whether or not to automatically generate a response when a VAD stop event occurs.

Optional<Eagerness> eagerness

Used only for semantic_vad mode. The eagerness of the model to respond. low will wait longer for the user to continue speaking, high will respond more quickly. auto is the default and is equivalent to medium. low, medium, and high have max timeouts of 8s, 4s, and 2s respectively.

Accepts one of the following:
LOW("low")
MEDIUM("medium")
HIGH("high")
AUTO("auto")
Optional<Boolean> interruptResponse

Whether or not to automatically interrupt any ongoing response with output to the default conversation (i.e. conversation of auto) when a VAD start event occurs.

Optional<Output> output
Optional<RealtimeAudioFormats> format

The format of the output audio.

Accepts one of the following:
AudioPcm
Optional<Rate> rate

The sample rate of the audio. Always 24000.

Optional<Type> type

The audio format. Always audio/pcm.

AudioPcmu
Optional<Type> type

The audio format. Always audio/pcmu.

AudioPcma
Optional<Type> type

The audio format. Always audio/pcma.

Optional<Double> speed

The speed of the model's spoken response as a multiple of the original speed. 1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.

This parameter is a post-processing adjustment to the audio after it is generated, it's also possible to prompt the model to speak faster or slower.

maximum1.5
minimum0.25
Optional<Voice> voice

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, verse, marin, and cedar. We recommend marin and cedar for best quality.

Accepts one of the following:
ALLOY("alloy")
ASH("ash")
BALLAD("ballad")
CORAL("coral")
ECHO("echo")
SAGE("sage")
SHIMMER("shimmer")
VERSE("verse")
MARIN("marin")
CEDAR("cedar")
Optional<List<Include>> include

Additional fields to include in server outputs.

item.input_audio_transcription.logprobs: Include logprobs for input audio transcription.

Optional<String> instructions

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.

Optional<MaxOutputTokens> maxOutputTokens

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.

Accepts one of the following:
long
JsonValue;
Optional<Model> model

The Realtime model used for this session.

Accepts one of the following:
GPT_REALTIME("gpt-realtime")
GPT_REALTIME_2025_08_28("gpt-realtime-2025-08-28")
GPT_4O_REALTIME_PREVIEW("gpt-4o-realtime-preview")
GPT_4O_REALTIME_PREVIEW_2024_10_01("gpt-4o-realtime-preview-2024-10-01")
GPT_4O_REALTIME_PREVIEW_2024_12_17("gpt-4o-realtime-preview-2024-12-17")
GPT_4O_REALTIME_PREVIEW_2025_06_03("gpt-4o-realtime-preview-2025-06-03")
GPT_4O_MINI_REALTIME_PREVIEW("gpt-4o-mini-realtime-preview")
GPT_4O_MINI_REALTIME_PREVIEW_2024_12_17("gpt-4o-mini-realtime-preview-2024-12-17")
GPT_REALTIME_MINI("gpt-realtime-mini")
GPT_REALTIME_MINI_2025_10_06("gpt-realtime-mini-2025-10-06")
GPT_REALTIME_MINI_2025_12_15("gpt-realtime-mini-2025-12-15")
GPT_AUDIO_MINI("gpt-audio-mini")
GPT_AUDIO_MINI_2025_10_06("gpt-audio-mini-2025-10-06")
GPT_AUDIO_MINI_2025_12_15("gpt-audio-mini-2025-12-15")
Optional<List<OutputModality>> outputModalities

The set of modalities the model can respond with. It defaults to ["audio"], indicating that the model will respond with audio plus a transcript. ["text"] can be used to make the model respond with text only. It is not possible to request both text and audio at the same time.

Accepts one of the following:
TEXT("text")
AUDIO("audio")
Optional<ResponsePrompt> prompt

Reference to a prompt template and its variables. Learn more.

String id

The unique identifier of the prompt template to use.

Optional<Variables> variables

Optional map of values to substitute in for variables in your prompt. The substitution values can either be strings, or other Response input types like images or files.

Accepts one of the following:
String
class ResponseInputText:

A text input to the model.

String text

The text input to the model.

JsonValue; type "input_text"constant"input_text"constant

The type of the input item. Always input_text.

class ResponseInputImage:

An image input to the model. Learn about image inputs.

Detail detail

The detail level of the image to be sent to the model. One of high, low, or auto. Defaults to auto.

Accepts one of the following:
LOW("low")
HIGH("high")
AUTO("auto")
JsonValue; type "input_image"constant"input_image"constant

The type of the input item. Always input_image.

Optional<String> fileId

The ID of the file to be sent to the model.

Optional<String> imageUrl

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

class ResponseInputFile:

A file input to the model.

JsonValue; type "input_file"constant"input_file"constant

The type of the input item. Always input_file.

Optional<String> fileData

The content of the file to be sent to the model.

Optional<String> fileId

The ID of the file to be sent to the model.

Optional<String> fileUrl

The URL of the file to be sent to the model.

Optional<String> filename

The name of the file to be sent to the model.

Optional<String> version

Optional version of the prompt template.

Optional<ToolChoice> toolChoice

How the model chooses tools. Provide one of the string modes or force a specific function/MCP tool.

Accepts one of the following:
enum ToolChoiceOptions:

Controls which (if any) tool is called by the model.

none means the model will not call any tool and instead generates a message.

auto means the model can pick between generating a message or calling one or more tools.

required means the model must call one or more tools.

NONE("none")
AUTO("auto")
REQUIRED("required")
class ToolChoiceFunction:

Use this option to force the model to call a specific function.

String name

The name of the function to call.

JsonValue; type "function"constant"function"constant

For function calling, the type is always function.

class ToolChoiceMcp:

Use this option to force the model to call a specific tool on a remote MCP server.

String serverLabel

The label of the MCP server to use.

JsonValue; type "mcp"constant"mcp"constant

For MCP tools, the type is always mcp.

Optional<String> name

The name of the tool to call on the server.

Optional<List<Tool>> tools

Tools available to the model.

Accepts one of the following:
class RealtimeFunctionTool:
Optional<String> description

The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything).

Optional<String> name

The name of the function.

Optional<JsonValue> parameters

Parameters of the function in JSON Schema.

Optional<Type> type

The type of the tool, i.e. function.

class McpTool:

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

String serverLabel

A label for this MCP server, used to identify it in tool calls.

JsonValue; type "mcp"constant"mcp"constant

The type of the MCP tool. Always mcp.

Optional<AllowedTools> allowedTools

List of allowed tool names or a filter object.

Accepts one of the following:
List<String>
class McpToolFilter:

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<String> authorization

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

Optional<ConnectorId> connectorId

Identifier for service connectors, like those available in ChatGPT. One of server_url or connector_id must be provided. Learn more about service connectors here.

Currently supported connector_id values are:

  • Dropbox: connector_dropbox
  • Gmail: connector_gmail
  • Google Calendar: connector_googlecalendar
  • Google Drive: connector_googledrive
  • Microsoft Teams: connector_microsoftteams
  • Outlook Calendar: connector_outlookcalendar
  • Outlook Email: connector_outlookemail
  • SharePoint: connector_sharepoint
Accepts one of the following:
CONNECTOR_DROPBOX("connector_dropbox")
CONNECTOR_GMAIL("connector_gmail")
CONNECTOR_GOOGLECALENDAR("connector_googlecalendar")
CONNECTOR_GOOGLEDRIVE("connector_googledrive")
CONNECTOR_MICROSOFTTEAMS("connector_microsoftteams")
CONNECTOR_OUTLOOKCALENDAR("connector_outlookcalendar")
CONNECTOR_OUTLOOKEMAIL("connector_outlookemail")
CONNECTOR_SHAREPOINT("connector_sharepoint")
Optional<Headers> headers

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

Optional<RequireApproval> requireApproval

Specify which of the MCP server's tools require approval.

Accepts one of the following:
class McpToolApprovalFilter:

Specify which of the MCP server's tools require approval. Can be always, never, or a filter object associated with tools that require approval.

Optional<Always> always

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

Optional<Never> never

A filter object to specify which tools are allowed.

Optional<Boolean> readOnly

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

Optional<List<String>> toolNames

List of allowed tool names.

enum McpToolApprovalSetting:

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

ALWAYS("always")
NEVER("never")
Optional<String> serverDescription

Optional description of the MCP server, used to provide more context.

Optional<String> serverUrl

The URL for the MCP server. One of server_url or connector_id must be provided.

Optional<Tracing> tracing

Realtime API can write session traces to the Traces Dashboard. 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.

Accepts one of the following:
JsonValue;
class TracingConfiguration:

Granular configuration for tracing.

Optional<String> groupId

The group id to attach to this trace to enable filtering and grouping in the Traces Dashboard.

Optional<JsonValue> metadata

The arbitrary metadata to attach to this trace to enable filtering in the Traces Dashboard.

Optional<String> workflowName

The name of the workflow to attach to this trace. This is used to name the trace in the Traces Dashboard.

Optional<RealtimeTruncation> truncation

When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.

Clients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.

Truncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.

Truncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.

Accepts one of the following:
RealtimeTruncationStrategy
Accepts one of the following:
AUTO("auto")
DISABLED("disabled")
class RealtimeTruncationRetentionRatio:

Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.

double retentionRatio

Fraction of post-instruction conversation tokens to retain (0.0 - 1.0) when the conversation exceeds the input token limit. Setting this to 0.8 means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.

minimum0
maximum1
JsonValue; type "retention_ratio"constant"retention_ratio"constant

Use retention ratio truncation.

Optional<TokenLimits> tokenLimits

Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.

Optional<Long> postInstructions

Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.

minimum0
class RealtimeTranscriptionSessionCreateResponse:

A Realtime transcription session configuration object.

String id

Unique identifier for the session that looks like sess_1234567890abcdef.

String object_

The object type. Always realtime.transcription_session.

JsonValue; type "transcription"constant"transcription"constant

The type of session. Always transcription for transcription sessions.

Optional<Audio> audio

Configuration for input audio for the session.

Optional<Input> input
Optional<RealtimeAudioFormats> format

The PCM audio format. Only a 24kHz sample rate is supported.

Accepts one of the following:
AudioPcm
Optional<Rate> rate

The sample rate of the audio. Always 24000.

Optional<Type> type

The audio format. Always audio/pcm.

AudioPcmu
Optional<Type> type

The audio format. Always audio/pcmu.

AudioPcma
Optional<Type> type

The audio format. Always audio/pcma.

Optional<NoiseReduction> noiseReduction

Configuration for input audio noise reduction.

Optional<NoiseReductionType> type

Type of noise reduction. near_field is for close-talking microphones such as headphones, far_field is for far-field microphones such as laptop or conference room microphones.

Accepts one of the following:
NEAR_FIELD("near_field")
FAR_FIELD("far_field")
Optional<AudioTranscription> transcription

Configuration of the transcription model.

Optional<String> language

The language of the input audio. Supplying the input language in ISO-639-1 (e.g. en) format will improve accuracy and latency.

Optional<Model> model

The model to use for transcription. Current options are whisper-1, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, gpt-4o-transcribe, and gpt-4o-transcribe-diarize. Use gpt-4o-transcribe-diarize when you need diarization with speaker labels.

Accepts one of the following:
WHISPER_1("whisper-1")
GPT_4O_MINI_TRANSCRIBE("gpt-4o-mini-transcribe")
GPT_4O_MINI_TRANSCRIBE_2025_12_15("gpt-4o-mini-transcribe-2025-12-15")
GPT_4O_TRANSCRIBE("gpt-4o-transcribe")
GPT_4O_TRANSCRIBE_DIARIZE("gpt-4o-transcribe-diarize")
Optional<String> prompt

An optional text to guide the model's style or continue a previous audio segment. For whisper-1, the prompt is a list of keywords. For gpt-4o-transcribe models (excluding gpt-4o-transcribe-diarize), the prompt is a free text string, for example "expect words related to technology".

Optional<RealtimeTranscriptionSessionTurnDetection> turnDetection

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.

Optional<Long> prefixPaddingMs

Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms.

Optional<Long> silenceDurationMs

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.

Optional<Double> threshold

Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments.

Optional<String> type

Type of turn detection, only server_vad is currently supported.

Optional<Long> expiresAt

Expiration timestamp for the session, in seconds since epoch.

Optional<List<Include>> include

Additional fields to include in server outputs.

  • item.input_audio_transcription.logprobs: Include logprobs for input audio transcription.
String value

The generated client secret value.

Create client secret

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.realtime.clientsecrets.ClientSecretCreateParams;
import com.openai.models.realtime.clientsecrets.ClientSecretCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ClientSecretCreateResponse clientSecret = client.realtime().clientSecrets().create();
    }
}
{
  "expires_at": 0,
  "session": {
    "client_secret": {
      "expires_at": 0,
      "value": "value"
    },
    "type": "realtime",
    "audio": {
      "input": {
        "format": {
          "rate": 24000,
          "type": "audio/pcm"
        },
        "noise_reduction": {
          "type": "near_field"
        },
        "transcription": {
          "language": "language",
          "model": "string",
          "prompt": "prompt"
        },
        "turn_detection": {
          "type": "server_vad",
          "create_response": true,
          "idle_timeout_ms": 5000,
          "interrupt_response": true,
          "prefix_padding_ms": 0,
          "silence_duration_ms": 0,
          "threshold": 0
        }
      },
      "output": {
        "format": {
          "rate": 24000,
          "type": "audio/pcm"
        },
        "speed": 0.25,
        "voice": "ash"
      }
    },
    "include": [
      "item.input_audio_transcription.logprobs"
    ],
    "instructions": "instructions",
    "max_output_tokens": 0,
    "model": "string",
    "output_modalities": [
      "text"
    ],
    "prompt": {
      "id": "id",
      "variables": {
        "foo": "string"
      },
      "version": "version"
    },
    "tool_choice": "none",
    "tools": [
      {
        "description": "description",
        "name": "name",
        "parameters": {},
        "type": "function"
      }
    ],
    "tracing": "auto",
    "truncation": "auto"
  },
  "value": "value"
}
Returns Examples
{
  "expires_at": 0,
  "session": {
    "client_secret": {
      "expires_at": 0,
      "value": "value"
    },
    "type": "realtime",
    "audio": {
      "input": {
        "format": {
          "rate": 24000,
          "type": "audio/pcm"
        },
        "noise_reduction": {
          "type": "near_field"
        },
        "transcription": {
          "language": "language",
          "model": "string",
          "prompt": "prompt"
        },
        "turn_detection": {
          "type": "server_vad",
          "create_response": true,
          "idle_timeout_ms": 5000,
          "interrupt_response": true,
          "prefix_padding_ms": 0,
          "silence_duration_ms": 0,
          "threshold": 0
        }
      },
      "output": {
        "format": {
          "rate": 24000,
          "type": "audio/pcm"
        },
        "speed": 0.25,
        "voice": "ash"
      }
    },
    "include": [
      "item.input_audio_transcription.logprobs"
    ],
    "instructions": "instructions",
    "max_output_tokens": 0,
    "model": "string",
    "output_modalities": [
      "text"
    ],
    "prompt": {
      "id": "id",
      "variables": {
        "foo": "string"
      },
      "version": "version"
    },
    "tool_choice": "none",
    "tools": [
      {
        "description": "description",
        "name": "name",
        "parameters": {},
        "type": "function"
      }
    ],
    "tracing": "auto",
    "truncation": "auto"
  },
  "value": "value"
}