Struct ThreadRealtimeStartParams 

pub struct ThreadRealtimeStartParams {

    pub client_managed_handoffs: Option<bool>,
    pub codex_response_handoff_prefix: Option<String>,
    pub codex_response_item_prefix: Option<String>,
    pub codex_responses_as_items: Option<bool>,
    pub flush_transcript_tail_on_session_end: Option<bool>,
    pub include_startup_context: Option<bool>,
    pub model: Option<String>,
    pub output_modality: RealtimeOutputModality,
    pub prompt: Option<String>,
    pub realtime_session_id: Option<String>,
    pub thread_id: String,
    pub transport: Option<ThreadRealtimeStartTransport>,
    pub version: Option<RealtimeConversationVersion>,
    pub voice: Option<RealtimeVoice>,
}

EXPERIMENTAL - start a thread-scoped realtime session.

JSON schema

{
 "title": "ThreadRealtimeStartParams",
 "description": "EXPERIMENTAL - start a thread-scoped realtime session.",
 "type": "object",
 "required": [
   "outputModality",
   "threadId"
 ],
 "properties": {
   "clientManagedHandoffs": {
     "description": "Leaves Codex response handoffs to the client's explicit append calls instead of forwarding them automatically. Defaults to false.",
     "type": [
       "boolean",
       "null"
     ]
   },
   "codexResponseHandoffPrefix": {
     "description": "Optional prefix added to automatic V1 Codex commentary sent with `conversation.handoff.append` when `codexResponsesAsItems` is not true. Final answers are sent without the prefix.",
     "type": [
       "string",
       "null"
     ]
   },
   "codexResponseItemPrefix": {
     "description": "Optional prefix added to automatic Codex response items when `codexResponsesAsItems` is true.",
     "type": [
       "string",
       "null"
     ]
   },
   "codexResponsesAsItems": {
     "description": "Sends automatic Codex responses as realtime conversation items instead of handoff appends.",
     "type": [
       "boolean",
       "null"
     ]
   },
   "flushTranscriptTailOnSessionEnd": {
     "description": "Routes any transcript tail remaining at session end through Codex. Defaults to false. TODO: Remove this rollout knob once transcript-tail flushing is always enabled.",
     "type": [
       "boolean",
       "null"
     ]
   },
   "includeStartupContext": {
     "description": "Set to false to start without Codex's startup context. Omitted or null includes it.",
     "type": [
       "boolean",
       "null"
     ]
   },
   "model": {
     "description": "Overrides the configured realtime model for this session only.",
     "type": [
       "string",
       "null"
     ]
   },
   "outputModality": {
     "description": "Selects text or audio output for the realtime session. Transport and voice stay independent so clients can choose how they connect separately from what the model emits.",
     "allOf": [
       {
         "$ref": "#/definitions/RealtimeOutputModality"
       }
     ]
   },
   "prompt": {
     "type": [
       "string",
       "null"
     ]
   },
   "realtimeSessionId": {
     "type": [
       "string",
       "null"
     ]
   },
   "threadId": {
     "type": "string"
   },
   "transport": {
     "anyOf": [
       {
         "$ref": "#/definitions/ThreadRealtimeStartTransport"
       },
       {
         "type": "null"
       }
     ]
   },
   "version": {
     "description": "Overrides the configured realtime protocol version for this session only.",
     "anyOf": [
       {
         "$ref": "#/definitions/RealtimeConversationVersion"
       },
       {
         "type": "null"
       }
     ]
   },
   "voice": {
     "anyOf": [
       {
         "$ref": "#/definitions/RealtimeVoice"
       },
       {
         "type": "null"
       }
     ]
   }
 },
 "$schema": "http://json-schema.org/draft-07/schema#"
}

Fields

client_managed_handoffs: Option<bool>

Leaves Codex response handoffs to the client’s explicit append calls instead of forwarding them automatically. Defaults to false.

codex_response_handoff_prefix: Option<String>

Optional prefix added to automatic V1 Codex commentary sent with conversation.handoff.append when codexResponsesAsItems is not true. Final answers are sent without the prefix.

codex_response_item_prefix: Option<String>

Optional prefix added to automatic Codex response items when codexResponsesAsItems is true.

codex_responses_as_items: Option<bool>

Sends automatic Codex responses as realtime conversation items instead of handoff appends.

flush_transcript_tail_on_session_end: Option<bool>

Routes any transcript tail remaining at session end through Codex. Defaults to false. TODO: Remove this rollout knob once transcript-tail flushing is always enabled.

include_startup_context: Option<bool>

Set to false to start without Codex’s startup context. Omitted or null includes it.

model: Option<String>

Overrides the configured realtime model for this session only.

output_modality: RealtimeOutputModality

Selects text or audio output for the realtime session. Transport and voice stay independent so clients can choose how they connect separately from what the model emits.

prompt: Option<String>

realtime_session_id: Option<String>

thread_id: String

transport: Option<ThreadRealtimeStartTransport>

version: Option<RealtimeConversationVersion>

Overrides the configured realtime protocol version for this session only.

voice: Option<RealtimeVoice>

Trait Implementations

impl Clone for ThreadRealtimeStartParams

fn clone(&self) -> ThreadRealtimeStartParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreadRealtimeStartParams

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ThreadRealtimeStartParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ThreadRealtimeStartParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.