Struct RealtimeSessionCreateResponse 

pub struct RealtimeSessionCreateResponse {

    pub client_secret: RealtimeSessionClientSecret,
    pub type_: String,
    pub audio: Option<Audio>,
    pub include: Option<Vec<String>>,
    pub instructions: Option<String>,
    pub max_output_tokens: Option<String>,
    pub model: Option<String>,
    pub output_modalities: Option<Vec<Value>>,
    pub prompt: Option<Value>,
    pub tool_choice: Option<ToolChoice>,
    pub tools: Option<Vec<RealtimeMcpTool>>,
    pub tracing: Option<Tracing>,
    pub truncation: Option<RealtimeTruncation>,
}

A new Realtime session configuration, with an ephemeral key.

Fields

client_secret: RealtimeSessionClientSecret

Ephemeral key returned by the API.

type_: String

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

audio: Option<Audio>

Configuration for input and output audio.

include: Option<Vec<String>>

Additional fields to include in server outputs.

instructions: Option<String>

The default system instructions (i.e.

max_output_tokens: Option<String>

Maximum number of output tokens for a single assistant response, inclusive of

model: Option<String>

The Realtime model used for this session.

output_modalities: Option<Vec<Value>>

The set of modalities the model can respond with.

prompt: Option<Value>

Reference to a prompt template and its variables.

tool_choice: Option<ToolChoice>

How the model chooses tools.

tools: Option<Vec<RealtimeMcpTool>>

Tools available to the model.

tracing: Option<Tracing>

Realtime API can write session traces to the

truncation: Option<RealtimeTruncation>

When the number of tokens in a conversation exceeds the model’s input token

Trait Implementations

impl Clone for RealtimeSessionCreateResponse

fn clone(&self) -> RealtimeSessionCreateResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RealtimeSessionCreateResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealtimeSessionCreateResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RealtimeSessionCreateResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.