diff --git a/en/resources/realtime/server-events.md b/en/resources/realtime/server-events.md index 06ac4bd6..a41b361f 100644 --- a/en/resources/realtime/server-events.md +++ b/en/resources/realtime/server-events.md @@ -123,22 +123,12 @@ Schema name: `RealtimeServerEventConversationCreated` "optional": true, "nullable": false, "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "realtime.conversation" - } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation/properties/object" + "kind": "HttpTypeString" }, "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation/properties/object", "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) realtime > (model) conversation_created_event > (schema) > (property) conversation > (property) object > (member) 0" - ] + "schemaType": "string", + "children": [] }, "(resource) realtime > (model) conversation_created_event > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", @@ -146,13 +136,6 @@ Schema name: `RealtimeServerEventConversationCreated` "kind": "HttpTypeLiteral", "literal": "conversation.created" } - }, - "(resource) realtime > (model) conversation_created_event > (schema) > (property) conversation > (property) object > (member) 0": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "realtime.conversation" - } } } ``` @@ -3201,8 +3184,8 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage/anyOf/0", - "ident": "TranscriptTextUsageTokens", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage/oneOf/0", + "ident": "TokenUsage", "type": { "kind": "HttpTypeObject", "members": [ @@ -3235,8 +3218,8 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage/anyOf/1", - "ident": "TranscriptTextUsageDuration", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage/oneOf/1", + "ident": "DurationUsage", "type": { "kind": "HttpTypeObject", "members": [ @@ -8825,11 +8808,11 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` "types": [ { "kind": "HttpTypeLiteral", - "literal": "text" + "literal": "audio" }, { "kind": "HttpTypeLiteral", - "literal": "audio" + "literal": "text" } ], "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/type" @@ -8854,14 +8837,14 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "text" + "literal": "audio" } }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) part > (property) type > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "audio" + "literal": "text" } } } @@ -9118,11 +9101,11 @@ Schema name: `RealtimeServerEventResponseContentPartDone` "types": [ { "kind": "HttpTypeLiteral", - "literal": "text" + "literal": "audio" }, { "kind": "HttpTypeLiteral", - "literal": "audio" + "literal": "text" } ], "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/type" @@ -9147,14 +9130,14 @@ Schema name: `RealtimeServerEventResponseContentPartDone` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "text" + "literal": "audio" } }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) part > (property) type > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "audio" + "literal": "text" } } } @@ -9353,7 +9336,7 @@ Schema name: `RealtimeServerEventResponseCreated` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" } ], "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens" @@ -9657,7 +9640,7 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) max_output_tokens > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/0", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeNumber" @@ -9666,7 +9649,7 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) max_output_tokens > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/1", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -9676,7 +9659,7 @@ Schema name: `RealtimeServerEventResponseCreated` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" }, "childrenParentSchema": "enum", "children": [ @@ -10064,11 +10047,11 @@ Schema name: `RealtimeServerEventResponseCreated` }, { "kind": "HttpTypeLiteral", - "literal": "incomplete" + "literal": "failed" }, { "kind": "HttpTypeLiteral", - "literal": "failed" + "literal": "incomplete" } ], "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type" @@ -11880,14 +11863,14 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "incomplete" + "literal": "failed" } }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) type > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "failed" + "literal": "incomplete" } }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) audio_tokens": { @@ -12063,7 +12046,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "AudioPCM", + "ident": "PCMAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -12085,7 +12068,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "AudioPCMU", + "ident": "PCMUAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -12103,7 +12086,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "AudioPCMA", + "ident": "PCMAAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -13538,7 +13521,7 @@ Schema name: `RealtimeServerEventResponseDone` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" } ], "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens" @@ -13842,7 +13825,7 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) max_output_tokens > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/0", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeNumber" @@ -13851,7 +13834,7 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) max_output_tokens > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/1", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -13861,7 +13844,7 @@ Schema name: `RealtimeServerEventResponseDone` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" }, "childrenParentSchema": "enum", "children": [ @@ -14249,11 +14232,11 @@ Schema name: `RealtimeServerEventResponseDone` }, { "kind": "HttpTypeLiteral", - "literal": "incomplete" + "literal": "failed" }, { "kind": "HttpTypeLiteral", - "literal": "failed" + "literal": "incomplete" } ], "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type" @@ -16065,14 +16048,14 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "incomplete" + "literal": "failed" } }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) type > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "failed" + "literal": "incomplete" } }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) audio_tokens": { @@ -16248,7 +16231,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "AudioPCM", + "ident": "PCMAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -16270,7 +16253,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "AudioPCMU", + "ident": "PCMUAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -16288,7 +16271,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "AudioPCMA", + "ident": "PCMAAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -23808,13 +23791,13 @@ Schema name: `RealtimeServerEventSessionCreated` "types": [ { "kind": "HttpTypeReference", - "ident": "RealtimeSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_session_create_request > (schema)" + "ident": "RealtimeSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)" }, { "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)" + "ident": "RealtimeTranscriptionSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)" } ], "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/session" @@ -23856,54 +23839,68 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", - "ident": "RealtimeSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_session_create_request > (schema)" + "ident": "RealtimeSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)" }, "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation" ] }, "(resource) realtime > (model) session_created_event > (schema) > (property) session > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)" + "ident": "RealtimeTranscriptionSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)" }, "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema)": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA", - "ident": "RealtimeSessionCreateRequest", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA", + "ident": "RealtimeSessionCreateResponse", "type": { "kind": "HttpTypeObject", "members": [ + { + "ident": "id" + }, + { + "ident": "object" + }, { "ident": "type" }, { "ident": "audio" }, + { + "ident": "expires_at" + }, { "ident": "include" }, @@ -23919,9 +23916,6 @@ Schema name: `RealtimeServerEventSessionCreated` { "ident": "output_modalities" }, - { - "ident": "parallel_tool_calls" - }, { "ident": "prompt" }, @@ -23942,49 +23936,63 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Realtime session object configuration.", + "docstring": "A Realtime session configuration object.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA", - "ident": "RealtimeTranscriptionSessionCreateRequest", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA", + "ident": "RealtimeTranscriptionSessionCreateResponse", "type": { "kind": "HttpTypeObject", "members": [ + { + "ident": "id" + }, + { + "ident": "object" + }, { "ident": "type" }, { "ident": "audio" }, + { + "ident": "expires_at" + }, { "ident": "include" } ] }, - "docstring": "Realtime transcription session object configuration.", + "docstring": "A Realtime transcription session configuration object.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include" ] }, "(resource) realtime > (model) session_created_event > (schema) > (property) type > (member) 0": { @@ -23994,7 +24002,45 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "session.created" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object": { + "kind": "HttpDeclProperty", + "docstring": "The object type. Always `realtime.session`.", + "key": "object", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "realtime.session" + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object > (member) 0" + ] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", "key": "type", @@ -24008,39 +24054,60 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "realtime" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", "docstring": "Configuration for input and output audio.\n", "key": "audio", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioConfig", - "$ref": "(resource) realtime > (model) realtime_audio_config > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "input" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio", + { + "ident": "output" + } + ] + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_config", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input", - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) output" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at": { + "kind": "HttpDeclProperty", + "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "key": "expires_at", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" + }, + "constraints": { + "format": "unixtime" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/expires_at", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include": { "kind": "HttpDeclProperty", "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "key": "include", @@ -24056,19 +24123,19 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "item.input_audio_transcription.logprobs" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include/items" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include/items" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", "deprecated": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include > (items) > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include > (items) > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions": { "kind": "HttpDeclProperty", "docstring": "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.\n\nNote 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.\n", "key": "instructions", @@ -24077,12 +24144,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/instructions", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/instructions", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens": { "kind": "HttpDeclProperty", "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n", "key": "max_output_tokens", @@ -24102,21 +24169,21 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model": { "kind": "HttpDeclProperty", "docstring": "The Realtime model used for this session.\n", "key": "model", @@ -24208,21 +24275,21 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "gpt-audio-mini-2025-12-15" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities": { "kind": "HttpDeclProperty", "docstring": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n", "key": "output_modalities", @@ -24245,36 +24312,22 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "audio" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities/items" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities/items" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", "deprecated": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.\n", - "key": "parallel_tool_calls", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/parallel_tool_calls", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt": { - "kind": "HttpDeclProperty", - "docstring": "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "key": "prompt", "optional": true, "nullable": true, @@ -24283,7 +24336,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "ResponsePrompt", "$ref": "(resource) responses > (model) response_prompt > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/prompt", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/prompt", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -24295,7 +24348,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) response_prompt > (schema) > (property) version" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning": { "kind": "HttpDeclProperty", "title": "Realtime reasoning configuration", "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", @@ -24307,7 +24360,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "RealtimeReasoning", "$ref": "(resource) realtime > (model) realtime_reasoning > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/reasoning", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/reasoning", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -24317,7 +24370,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", "key": "tool_choice", @@ -24325,45 +24378,108 @@ Schema name: `RealtimeServerEventSessionCreated` "nullable": false, "default": "auto", "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "ToolChoiceOptions", + "$ref": "(resource) responses > (model) tool_choice_options > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "RealtimeToolChoiceConfig", - "$ref": "(resource) realtime > (model) realtime_tool_choice_config > (schema)" + "ident": "ToolChoiceFunction", + "$ref": "(resource) responses > (model) tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice", + { + "kind": "HttpTypeReference", + "ident": "ToolChoiceMcp", + "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", "deprecated": false, "schemaType": "union", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_tool_choice_config", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 2" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools": { "kind": "HttpDeclProperty", "docstring": "Tools available to the model.", "key": "tools", "optional": true, "nullable": false, "type": { + "kind": "HttpTypeArray", + "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "RealtimeToolsConfig", - "$ref": "(resource) realtime > (model) realtime_tools_config > (schema)" + "ident": "RealtimeFunctionTool", + "$ref": "(resource) realtime > (model) realtime_function_tool > (schema)" + }, + { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "server_label" + }, + { + "ident": "type" + }, + { + "ident": "allowed_callers" + }, + { + "ident": "allowed_tools" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", + { + "ident": "authorization" + }, + { + "ident": "connector_id" + }, + { + "ident": "defer_loading" + }, + { + "ident": "headers" + }, + { + "ident": "require_approval" + }, + { + "ident": "server_description" + }, + { + "ident": "server_url" + }, + { + "ident": "tunnel_id" + } + ] + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", "deprecated": false, "schemaType": "array", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_tools_config", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing": { "kind": "HttpDeclProperty", "title": "Tracing Configuration", "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", @@ -24371,22 +24487,45 @@ Schema name: `RealtimeServerEventSessionCreated` "optional": true, "nullable": true, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTracingConfig", - "$ref": "(resource) realtime > (model) realtime_tracing_config > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "auto" + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" + }, + { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "group_id" + }, + { + "ident": "metadata" + }, + { + "ident": "workflow_name" + } + ] + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", "deprecated": false, "schemaType": "union", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_tracing_config", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation": { "kind": "HttpDeclProperty", "title": "Realtime Truncation Controls", "docstring": "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.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation 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.\n\nTruncation 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.\n", @@ -24398,7 +24537,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "RealtimeTruncation", "$ref": "(resource) realtime > (model) realtime_truncation > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/truncation", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/truncation", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -24409,9 +24548,37 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The type of session to create. Always `transcription` for transcription sessions.\n", + "docstring": "The object type. Always `realtime.transcription_session`.", + "key": "object", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/object", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of session. Always `transcription` for transcription sessions.\n", "key": "type", "optional": false, "nullable": false, @@ -24423,40 +24590,58 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "transcription" } ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input and output audio.\n", + "docstring": "Configuration for input audio for the session.\n", "key": "audio", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionAudio", - "$ref": "(resource) realtime > (model) realtime_transcription_session_audio > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "input" + } + ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", + "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "key": "expires_at", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" + }, + "constraints": { + "format": "unixtime" + }, + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/expires_at", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include": { + "kind": "HttpDeclProperty", + "docstring": "Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "key": "include", "optional": true, "nullable": false, @@ -24470,111 +24655,113 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "item.input_audio_transcription.logprobs" } ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include/items" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include/items" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", "deprecated": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include > (items) > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include > (items) > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object > (member) 0": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "realtime.session" + } + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "realtime" } }, - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", "key": "input", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioConfigInput", - "$ref": "(resource) realtime > (model) realtime_audio_config_input > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "format" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input", + { + "ident": "noise_reduction" + }, + { + "ident": "transcription" + }, + { + "ident": "turn_detection" + } + ] + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_config_input", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) format", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection" ] }, - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) output": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output": { "kind": "HttpDeclProperty", "key": "output", "optional": true, "nullable": false, - "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioConfigOutput", - "$ref": "(resource) realtime > (model) realtime_audio_config_output > (schema)" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output", - "deprecated": false, - "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_config_output", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice" - ] - }, - "(resource) realtime > (model) realtime_audio_config > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio", - "ident": "RealtimeAudioConfig", "type": { "kind": "HttpTypeObject", "members": [ { - "ident": "input" + "ident": "format" }, { - "ident": "output" + "ident": "speed" + }, + { + "ident": "voice" } ] }, - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output", + "deprecated": false, + "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input", - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) output" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) format", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) speed", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/0", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeNumber" }, "children": [] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/1", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -24584,25 +24771,25 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" }, "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/0", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeString" }, "children": [] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -24684,40 +24871,40 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "gpt-audio-mini-2025-12-15" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" }, "docstring": "The Realtime model used for this session.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 1", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 2", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 3", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 4", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 5", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 6", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 7", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 8", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 9", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 10", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 11", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 12", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 13", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 14", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 15", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 16", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 17", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 18" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 7", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 8", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 9", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 10", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 11", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 12", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 13", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 14", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 15", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 16", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 17", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 18" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "text" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -24822,7 +25009,7 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_prompt > (schema) > (property) id", @@ -24874,7 +25061,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -24888,7 +25075,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) tool_choice_options > (schema) > (member) 2" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -24901,7 +25088,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) tool_choice_function > (schema) > (property) type" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -24915,40 +25102,85 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema)": { + "(resource) responses > (model) tool_choice_options > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice", - "ident": "RealtimeToolChoiceConfig", + "oasRef": "#/components/schemas/ToolChoiceOptions", + "ident": "ToolChoiceOptions", "type": { "kind": "HttpTypeUnion", "types": [ { - "kind": "HttpTypeReference", - "ident": "ToolChoiceOptions", - "$ref": "(resource) responses > (model) tool_choice_options > (schema)" + "kind": "HttpTypeLiteral", + "literal": "none" }, { - "kind": "HttpTypeReference", + "kind": "HttpTypeLiteral", + "literal": "auto" + }, + { + "kind": "HttpTypeLiteral", + "literal": "required" + } + ], + "oasRef": "#/components/schemas/ToolChoiceOptions" + }, + "docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n", + "childrenParentSchema": "enum", + "children": [ + "(resource) responses > (model) tool_choice_options > (schema) > (member) 0", + "(resource) responses > (model) tool_choice_options > (schema) > (member) 1", + "(resource) responses > (model) tool_choice_options > (schema) > (member) 2" + ] + }, + "(resource) responses > (model) tool_choice_function > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/ToolChoiceFunction", "ident": "ToolChoiceFunction", - "$ref": "(resource) responses > (model) tool_choice_function > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "name" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "Use this option to force the model to call a specific function.\n", + "childrenParentSchema": "object", + "children": [ + "(resource) responses > (model) tool_choice_function > (schema) > (property) name", + "(resource) responses > (model) tool_choice_function > (schema) > (property) type" + ] + }, + "(resource) responses > (model) tool_choice_mcp > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/ToolChoiceMCP", "ident": "ToolChoiceMcp", - "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "server_label" + }, + { + "ident": "type" + }, + { + "ident": "name" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice" + ] }, - "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", - "childrenParentSchema": "union", + "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", + "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2" + "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label", + "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type", + "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -24963,10 +25195,10 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items/anyOf/1", - "ident": "Mcp", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items/oneOf/1", + "ident": "McpTool", "type": { "kind": "HttpTypeObject", "members": [ @@ -25008,46 +25240,55 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).\n", + "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_label", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) authorization", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) defer_loading", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) headers", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_description", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_url", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) tunnel_id" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) authorization", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) headers", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_url", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) tunnel_id" ] }, - "(resource) realtime > (model) realtime_tools_config > (schema)": { + "(resource) realtime > (model) realtime_function_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", - "ident": "RealtimeToolsConfig", + "oasRef": "#/components/schemas/RealtimeFunctionTool", + "ident": "RealtimeFunctionTool", "type": { - "kind": "HttpTypeArray", - "elementType": { - "kind": "HttpTypeReference", - "ident": "RealtimeToolsConfigUnion", - "$ref": "(resource) realtime > (model) realtime_tools_config_union > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "description" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools" + { + "ident": "name" }, - "docstring": "Tools available to the model.", - "childrenParentSchema": "union", + { + "ident": "parameters" + }, + { + "ident": "type" + } + ] + }, + "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1" + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description", + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name", + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters", + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type" ] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/0", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", "ident": "Auto", "type": { "kind": "HttpTypeUnion", @@ -25057,17 +25298,17 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "auto" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/0" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" }, "docstring": "Enables tracing and sets default values for tracing configuration options. Always `auto`.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0 > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0 > (member) 0" ] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1", "ident": "TracingConfiguration", "type": { "kind": "HttpTypeObject", @@ -25086,56 +25327,15 @@ Schema name: `RealtimeServerEventSessionCreated` "docstring": "Granular configuration for tracing.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) group_id", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) metadata", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) workflow_name" - ] - }, - "(resource) realtime > (model) realtime_tracing_config > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing", - "ident": "RealtimeTracingConfig", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "auto" - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/0" - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "group_id" - }, - { - "ident": "metadata" - }, - { - "ident": "workflow_name" - } - ] - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing" - }, - "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) metadata", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) workflow_name" ] }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/0", - "ident": "RealtimeTruncationStrategy", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -25148,7 +25348,7 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "disabled" } ], - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/0" + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0" }, "docstring": "The truncation strategy to use for the session. `auto` is the default truncation strategy. `disabled` will disable truncation and emit errors when the conversation exceeds the input token limit.", "childrenParentSchema": "enum", @@ -25158,17 +25358,29 @@ Schema name: `RealtimeServerEventSessionCreated` ] }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1": { - "kind": "HttpDeclReference", + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1", + "ident": "RetentionRatioTruncation", "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTruncationRetentionRatio", - "$ref": "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "retention_ratio" }, + { + "ident": "type" + }, + { + "ident": "token_limits" + } + ] + }, + "docstring": "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.", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) retention_ratio", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits" + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio", + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type", + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits" ] }, "(resource) realtime > (model) realtime_truncation > (schema)": { @@ -25190,12 +25402,21 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "disabled" } ], - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/0" + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0" }, { - "kind": "HttpTypeReference", - "ident": "RealtimeTruncationRetentionRatio", - "$ref": "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "retention_ratio" + }, + { + "ident": "type" + }, + { + "ident": "token_limits" + } + ] } ], "oasRef": "#/components/schemas/RealtimeTruncation" @@ -25207,62 +25428,54 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "transcription" } }, - "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", "key": "input", "optional": true, "nullable": false, - "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionAudioInput", - "$ref": "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema)" - }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input", - "deprecated": false, - "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio", - "ident": "RealtimeTranscriptionSessionAudio", "type": { "kind": "HttpTypeObject", "members": [ { - "ident": "input" + "ident": "format" + }, + { + "ident": "noise_reduction" + }, + { + "ident": "transcription" + }, + { + "ident": "turn_detection" } ] }, - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input", + "deprecated": false, + "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) format", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", "docstring": "The format of the input audio.", "key": "format", @@ -25273,7 +25486,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/format", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/format", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -25285,7 +25498,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", "key": "noise_reduction", @@ -25299,39 +25512,45 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction > (property) type" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "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](https://platform.openai.com/docs/api-reference/audio/createTranscription) 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.\n", + "docstring": "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](/docs/api-reference/audio/createTranscription) 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.\n", "key": "transcription", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "AudioTranscription", - "$ref": "(resource) realtime > (model) audio_transcription > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "language" + }, + { + "ident": "model" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", + { + "ident": "prompt" + } + ] + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) audio_transcription", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", - "(resource) realtime > (model) audio_transcription > (schema) > (property) language", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model", - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", "title": "Realtime Turn Detection", "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", @@ -25339,51 +25558,64 @@ Schema name: `RealtimeServerEventSessionCreated` "optional": true, "nullable": true, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioInputTurnDetection", - "$ref": "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, - "schemaType": "union", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_input_turn_detection", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1" + { + "ident": "create_response" + }, + { + "ident": "idle_timeout_ms" + }, + { + "ident": "interrupt_response" + }, + { + "ident": "prefix_padding_ms" + }, + { + "ident": "silence_duration_ms" + }, + { + "ident": "threshold" + } ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input", - "ident": "RealtimeAudioConfigInput", - "type": { + { "kind": "HttpTypeObject", "members": [ { - "ident": "format" + "ident": "type" }, { - "ident": "noise_reduction" + "ident": "create_response" }, { - "ident": "transcription" + "ident": "eagerness" }, { - "ident": "turn_detection" + "ident": "interrupt_response" } ] + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection" }, - "childrenParentSchema": "object", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, + "schemaType": "union", + "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1" ] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) format": { "kind": "HttpDeclProperty", "docstring": "The format of the output audio.", "key": "format", @@ -25394,7 +25626,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/format", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/format", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -25406,7 +25638,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) speed": { "kind": "HttpDeclProperty", "docstring": "The speed of the model's spoken response as a multiple of the original speed.\n1.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.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n", "key": "speed", @@ -25420,15 +25652,14 @@ Schema name: `RealtimeServerEventSessionCreated` "maximum": 1.5, "minimum": 0.25 }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/speed", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/speed", "deprecated": false, "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice": { "kind": "HttpDeclProperty", - "title": "Voice", - "docstring": "The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`,\n`marin`, and `cedar`. You may also provide a custom voice object with\nan `id`, for example `{ \"id\": \"voice_1234\" }`. Voice cannot be changed\nduring the session once the model has responded with audio at least once.\nWe recommend `marin` and `cedar` for best quality.\n", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "key": "voice", "optional": true, "nullable": false, @@ -25484,187 +25715,156 @@ Schema name: `RealtimeServerEventSessionCreated` } ], "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - } - ] } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice", + "examples": [ + "ash" + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 0", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1" ] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output", - "ident": "RealtimeAudioConfigOutput", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "format" - }, - { - "ident": "speed" - }, - { - "ident": "voice" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice" - ] - }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inf" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-1.5" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2.1" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2.1-mini" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2025-08-28" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 6": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 7": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview-2024-10-01" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 8": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview-2024-12-17" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 9": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 9": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview-2025-06-03" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 10": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 10": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-realtime-preview" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 11": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 11": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-realtime-preview-2024-12-17" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 12": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 12": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-mini" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 13": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 13": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-mini-2025-10-06" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 14": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 14": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-mini-2025-12-15" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 15": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 15": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-audio-1.5" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 16": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 16": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 17": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 17": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-10-06" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 18": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 18": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -25673,7 +25873,7 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties/anyOf/0", + "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeString" @@ -25778,7 +25978,7 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).", + "docstring": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_image > (schema) > (property) detail", @@ -25926,36 +26126,6 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "required" } }, - "(resource) responses > (model) tool_choice_options > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ToolChoiceOptions", - "ident": "ToolChoiceOptions", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "none" - }, - { - "kind": "HttpTypeLiteral", - "literal": "auto" - }, - { - "kind": "HttpTypeLiteral", - "literal": "required" - } - ], - "oasRef": "#/components/schemas/ToolChoiceOptions" - }, - "docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n", - "childrenParentSchema": "enum", - "children": [ - "(resource) responses > (model) tool_choice_options > (schema) > (member) 0", - "(resource) responses > (model) tool_choice_options > (schema) > (member) 1", - "(resource) responses > (model) tool_choice_options > (schema) > (member) 2" - ] - }, "(resource) responses > (model) tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", "docstring": "The name of the function to call.", @@ -25994,28 +26164,6 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) tool_choice_function > (schema) > (property) type > (member) 0" ] }, - "(resource) responses > (model) tool_choice_function > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ToolChoiceFunction", - "ident": "ToolChoiceFunction", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "name" - }, - { - "ident": "type" - } - ] - }, - "docstring": "Use this option to force the model to call a specific function.\n", - "childrenParentSchema": "object", - "children": [ - "(resource) responses > (model) tool_choice_function > (schema) > (property) name", - "(resource) responses > (model) tool_choice_function > (schema) > (property) type" - ] - }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": { "kind": "HttpDeclProperty", "docstring": "The label of the MCP server to use.\n", @@ -26068,32 +26216,6 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "string", "children": [] }, - "(resource) responses > (model) tool_choice_mcp > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ToolChoiceMCP", - "ident": "ToolChoiceMcp", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "server_label" - }, - { - "ident": "type" - }, - { - "ident": "name" - } - ] - }, - "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", - "childrenParentSchema": "object", - "children": [ - "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label", - "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type", - "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name" - ] - }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description": { "kind": "HttpDeclProperty", "docstring": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n", @@ -26160,36 +26282,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeFunctionTool", - "ident": "RealtimeFunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "description" - }, - { - "ident": "name" - }, - { - "ident": "parameters" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description", - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name", - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters", - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type" - ] - }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_label": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label": { "kind": "HttpDeclProperty", "docstring": "A label for this MCP server, used to identify it in tool calls.\n", "key": "server_label", @@ -26203,7 +26296,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of the MCP tool. Always `mcp`.", "key": "type", @@ -26224,10 +26317,10 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers": { "kind": "HttpDeclProperty", "docstring": "The tool invocation context(s).", "key": "allowed_callers", @@ -26256,11 +26349,11 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 1" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools": { "kind": "HttpDeclProperty", "docstring": "List of allowed tool names or a filter object.\n", "key": "allowed_tools", @@ -26274,7 +26367,7 @@ Schema name: `RealtimeServerEventSessionCreated` "elementType": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/0" + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" }, { "kind": "HttpTypeObject", @@ -26295,11 +26388,11 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) authorization": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) authorization": { "kind": "HttpDeclProperty", "docstring": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n", "key": "authorization", @@ -26313,9 +26406,9 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id": { "kind": "HttpDeclProperty", - "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", + "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", "key": "connector_id", "optional": true, "nullable": false, @@ -26362,17 +26455,17 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 1", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 2", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 3", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 4", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 5", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 6", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 7" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 7" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) defer_loading": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading": { "kind": "HttpDeclProperty", "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", "key": "defer_loading", @@ -26386,7 +26479,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) headers": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) headers": { "kind": "HttpDeclProperty", "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", "key": "headers", @@ -26410,7 +26503,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "map", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval": { "kind": "HttpDeclProperty", "docstring": "Specify which of the MCP server's tools require approval.", "key": "require_approval", @@ -26443,7 +26536,7 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "never" } ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/1" + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" } ], "oasRef": "#/components/schemas/MCPTool/properties/require_approval" @@ -26453,11 +26546,11 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_description": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description": { "kind": "HttpDeclProperty", "docstring": "Optional description of the MCP server, used to provide more context.\n", "key": "server_description", @@ -26471,7 +26564,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_url": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_url": { "kind": "HttpDeclProperty", "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", "key": "server_url", @@ -26488,7 +26581,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) tunnel_id": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) tunnel_id": { "kind": "HttpDeclProperty", "docstring": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.\n", "key": "tunnel_id", @@ -26502,77 +26595,14 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items", - "ident": "RealtimeToolsConfigUnion", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeReference", - "ident": "RealtimeFunctionTool", - "$ref": "(resource) realtime > (model) realtime_function_tool > (schema)" - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "server_label" - }, - { - "ident": "type" - }, - { - "ident": "allowed_callers" - }, - { - "ident": "allowed_tools" - }, - { - "ident": "authorization" - }, - { - "ident": "connector_id" - }, - { - "ident": "defer_loading" - }, - { - "ident": "headers" - }, - { - "ident": "require_approval" - }, - { - "ident": "server_description" - }, - { - "ident": "server_url" - }, - { - "ident": "tunnel_id" - } - ] - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items" - }, - "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).\n", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1" - ] - }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) group_id": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id": { "kind": "HttpDeclProperty", "docstring": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n", "key": "group_id", @@ -26581,12 +26611,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1/properties/group_id", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/group_id", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) metadata": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) metadata": { "kind": "HttpDeclProperty", "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", "key": "metadata", @@ -26595,12 +26625,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1/properties/metadata", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/metadata", "deprecated": false, "schemaType": "unknown", "children": [] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) workflow_name": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) workflow_name": { "kind": "HttpDeclProperty", "docstring": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n", "key": "workflow_name", @@ -26609,7 +26639,7 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1/properties/workflow_name", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/workflow_name", "deprecated": false, "schemaType": "string", "children": [] @@ -26628,7 +26658,7 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "disabled" } }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) retention_ratio": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "retention_ratio", @@ -26641,12 +26671,12 @@ Schema name: `RealtimeServerEventSessionCreated` "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/retention_ratio", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", "deprecated": false, "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "docstring": "Use retention ratio truncation.", "key": "type", @@ -26660,17 +26690,17 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "retention_ratio" } ], - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/type" + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/type", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type > (member) 0" + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits": { "kind": "HttpDeclProperty", "docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.", "key": "token_limits", @@ -26684,41 +26714,15 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/token_limits", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits > (property) post_instructions" - ] - }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1", - "ident": "RealtimeTruncationRetentionRatio", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "retention_ratio" - }, - { - "ident": "type" - }, - { - "ident": "token_limits" - } - ] - }, - "docstring": "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.", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) retention_ratio", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits" + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "key": "format", @@ -26729,7 +26733,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/format", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/format", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -26741,9 +26745,9 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", + "docstring": "Configuration for input audio noise reduction.\n", "key": "noise_reduction", "optional": true, "nullable": false, @@ -26755,94 +26759,72 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction > (property) type" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "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](https://platform.openai.com/docs/api-reference/audio/createTranscription) 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.\n", + "docstring": "Configuration of the transcription model.\n", "key": "transcription", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "AudioTranscription", - "$ref": "(resource) realtime > (model) audio_transcription > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "language" + }, + { + "ident": "model" + }, + { + "ident": "prompt" + } + ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) audio_transcription", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", - "(resource) realtime > (model) audio_transcription > (schema) > (property) language", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model", - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", - "title": "Realtime Turn Detection", - "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "key": "turn_detection", "optional": true, "nullable": true, "type": { "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionAudioInputTurnDetection", - "$ref": "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema)" + "ident": "RealtimeTranscriptionSessionTurnDetection", + "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", "deprecated": false, - "schemaType": "union", + "schemaType": "object", "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input", - "ident": "RealtimeTranscriptionSessionAudioInput", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "format" - }, - { - "ident": "noise_reduction" - }, - { - "ident": "transcription" - }, - { - "ident": "turn_detection" - } - ] - }, + "modelPath": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type" ] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "AudioPCM", + "ident": "PCMAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -26864,7 +26846,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "AudioPCMU", + "ident": "PCMUAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -26882,7 +26864,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "AudioPCMA", + "ident": "PCMAAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -26942,7 +26924,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "type", @@ -26953,7 +26935,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", "deprecated": false, "schemaType": "enum", "modelImplicit": false, @@ -26964,67 +26946,23 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1" ] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay": { - "kind": "HttpDeclProperty", - "docstring": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.\n", - "key": "delay", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "minimal" - }, - { - "kind": "HttpTypeLiteral", - "literal": "low" - }, - { - "kind": "HttpTypeLiteral", - "literal": "medium" - }, - { - "kind": "HttpTypeLiteral", - "literal": "high" - }, - { - "kind": "HttpTypeLiteral", - "literal": "xhigh" - } - ], - "oasRef": "#/components/schemas/AudioTranscription/properties/delay" - }, - "oasRef": "#/components/schemas/AudioTranscription/properties/delay", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 0", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 1", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 2", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 3", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 4" - ] - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) language": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { "kind": "HttpDeclProperty", - "docstring": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.\n", + "docstring": "The language of the input audio.\n", "key": "language", "optional": true, "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscription/properties/language", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { "kind": "HttpDeclProperty", - "docstring": "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`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.\n", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "key": "model", "optional": true, "nullable": false, @@ -27062,66 +27000,37 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "gpt-realtime-whisper" } ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" } ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" }, - "oasRef": "#/components/schemas/AudioTranscription/properties/model", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 0", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1" ] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](https://platform.openai.com/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\nPrompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.\n", + "docstring": "The prompt configured for input audio transcription, when present.\n", "key": "prompt", "optional": true, "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscription/properties/prompt", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) audio_transcription > (schema)": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AudioTranscription", - "ident": "AudioTranscription", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "delay" - }, - { - "ident": "language" - }, - { - "ident": "model" - }, - { - "ident": "prompt" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", - "(resource) realtime > (model) audio_transcription > (schema) > (property) language", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model", - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" - ] - }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0", "ident": "ServerVad", "type": { "kind": "HttpTypeObject", @@ -27152,18 +27061,18 @@ Schema name: `RealtimeServerEventSessionCreated` "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) create_response", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) idle_timeout_ms", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) interrupt_response", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) prefix_padding_ms", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) silence_duration_ms", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) threshold" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1", "ident": "SemanticVad", "type": { "kind": "HttpTypeObject", @@ -27185,73 +27094,13 @@ Schema name: `RealtimeServerEventSessionCreated` "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response" - ] - }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "ident": "RealtimeAudioInputTurnDetection", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "create_response" - }, - { - "ident": "idle_timeout_ms" - }, - { - "ident": "interrupt_response" - }, - { - "ident": "prefix_padding_ms" - }, - { - "ident": "silence_duration_ms" - }, - { - "ident": "threshold" - } - ] - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "create_response" - }, - { - "ident": "eagerness" - }, - { - "ident": "interrupt_response" - } - ] - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection" - }, - "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) create_response", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) interrupt_response" ] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/0", "ident": "UnionMember0", @@ -27260,7 +27109,7 @@ Schema name: `RealtimeServerEventSessionCreated` }, "children": [] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "ident": "UnionMember1", @@ -27310,36 +27159,19 @@ Schema name: `RealtimeServerEventSessionCreated` ], "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" }, + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 0", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 1", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 2", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 3", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 4", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 5", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 6", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 7", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 8", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 9" - ] - }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1", - "ident": "ID", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - } - ] - }, - "docstring": "Custom voice reference.", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2 > (property) id" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 7", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 8", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 9" ] }, "(resource) responses > (model) response_input_text > (schema) > (property) text": { @@ -27684,44 +27516,44 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "function" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "direct" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "programmatic" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/0", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "ident": "McpAllowedTools", "type": { "kind": "HttpTypeArray", "elementType": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/0" + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" }, "docstring": "A string array of allowed tool names", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/1", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/1", "ident": "McpToolFilter", "type": { "kind": "HttpTypeObject", @@ -27737,69 +27569,69 @@ Schema name: `RealtimeServerEventSessionCreated` "docstring": "A filter object to specify which tools are allowed.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_dropbox" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_gmail" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_googlecalendar" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_googledrive" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_microsoftteams" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_outlookcalendar" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 6": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_outlookemail" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 7": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_sharepoint" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/0", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0", "ident": "McpToolApprovalFilter", "type": { "kind": "HttpTypeObject", @@ -27815,13 +27647,13 @@ Schema name: `RealtimeServerEventSessionCreated` "docstring": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/1", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "ident": "McpToolApprovalSetting", "type": { "kind": "HttpTypeUnion", @@ -27835,23 +27667,23 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "never" } ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/1" + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" }, "docstring": "Specify a single approval policy for all tools. One of `always` or\n`never`. When set to `always`, all tools will require approval. When\nset to `never`, all tools will not require approval.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1" ] }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type > (member) 0": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "retention_ratio" } }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits > (property) post_instructions": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions": { "kind": "HttpDeclProperty", "docstring": "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.", "key": "post_instructions", @@ -27863,12 +27695,12 @@ Schema name: `RealtimeServerEventSessionCreated` "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/token_limits/properties/post_instructions", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "type", @@ -27879,7 +27711,7 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", "deprecated": false, "schemaType": "enum", "modelImplicit": false, @@ -27890,100 +27722,151 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0", - "ident": "ServerVad", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { + "kind": "HttpDeclProperty", + "docstring": "The language of the input audio.\n", + "key": "language", + "optional": true, + "nullable": false, "type": { - "kind": "HttpTypeObject", - "members": [ + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { + "kind": "HttpDeclProperty", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", + "key": "model", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ { - "ident": "type" + "kind": "HttpTypeString" }, { - "ident": "create_response" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "whisper-1" }, { - "ident": "idle_timeout_ms" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-mini-transcribe" }, { - "ident": "interrupt_response" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-mini-transcribe-2025-12-15" }, { - "ident": "prefix_padding_ms" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe" }, { - "ident": "silence_duration_ms" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe-diarize" }, { - "ident": "threshold" + "kind": "HttpTypeLiteral", + "literal": "gpt-realtime-whisper" } - ] + ], + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + } + ], + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" }, - "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", - "childrenParentSchema": "object", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", + "deprecated": false, + "schemaType": "union", + "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1", - "ident": "SemanticVad", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { + "kind": "HttpDeclProperty", + "docstring": "The prompt configured for input audio transcription, when present.\n", + "key": "prompt", + "optional": true, + "nullable": false, "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" + "kind": "HttpTypeString" }, - { - "ident": "create_response" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", + "deprecated": false, + "schemaType": "string", + "children": [] }, - { - "ident": "eagerness" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms": { + "kind": "HttpDeclProperty", + "docstring": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", + "key": "prefix_padding_ms", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" }, - { - "ident": "interrupt_response" - } - ] + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/prefix_padding_ms", + "deprecated": false, + "schemaType": "integer", + "children": [] }, - "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response" - ] + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms": { + "kind": "HttpDeclProperty", + "docstring": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", + "key": "silence_duration_ms", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "ident": "RealtimeTranscriptionSessionAudioInputTurnDetection", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/silence_duration_ms", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold": { + "kind": "HttpDeclProperty", + "docstring": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", + "key": "threshold", + "optional": true, + "nullable": false, "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" + "kind": "HttpTypeNumber" }, - { - "ident": "create_response" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/threshold", + "deprecated": false, + "schemaType": "number", + "children": [] }, - { - "ident": "idle_timeout_ms" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "Type of turn detection, only `server_vad` is currently supported.\n", + "key": "type", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeString" }, - { - "ident": "interrupt_response" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/type", + "deprecated": false, + "schemaType": "string", + "children": [] }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "ident": "RealtimeTranscriptionSessionTurnDetection", + "type": { + "kind": "HttpTypeObject", + "members": [ { "ident": "prefix_padding_ms" }, @@ -27992,34 +27875,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, { "ident": "threshold" - } - ] }, - { - "kind": "HttpTypeObject", - "members": [ { "ident": "type" - }, - { - "ident": "create_response" - }, - { - "ident": "eagerness" - }, - { - "ident": "interrupt_response" } ] - } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection" }, - "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", - "childrenParentSchema": "union", + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", + "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type" ] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { @@ -28157,53 +28025,18 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1" ] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 0": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "minimal" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 1": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "low" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 2": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "medium" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 3": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "high" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 4": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "xhigh" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/0", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeString" }, "children": [] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -28233,20 +28066,20 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "gpt-realtime-whisper" } ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" }, - "docstring": "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`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.\n", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 0", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 1", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 2", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 3", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 4", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", "key": "type", @@ -28261,17 +28094,17 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "server_vad" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type" + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) create_response": { "kind": "HttpDeclProperty", "docstring": "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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "key": "create_response", @@ -28281,12 +28114,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/create_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) idle_timeout_ms": { "kind": "HttpDeclProperty", "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", "key": "idle_timeout_ms", @@ -28299,12 +28132,12 @@ Schema name: `RealtimeServerEventSessionCreated` "minimum": 5000, "maximum": 30000 }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/idle_timeout_ms", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) interrupt_response": { "kind": "HttpDeclProperty", "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "key": "interrupt_response", @@ -28314,12 +28147,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/interrupt_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) prefix_padding_ms": { "kind": "HttpDeclProperty", "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "key": "prefix_padding_ms", @@ -28328,12 +28161,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/prefix_padding_ms", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) silence_duration_ms": { "kind": "HttpDeclProperty", "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", "key": "silence_duration_ms", @@ -28342,12 +28175,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/silence_duration_ms", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) threshold": { "kind": "HttpDeclProperty", "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", "key": "threshold", @@ -28356,12 +28189,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/threshold", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", "deprecated": false, "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", "key": "type", @@ -28375,17 +28208,17 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "semantic_vad" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type" + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) create_response": { "kind": "HttpDeclProperty", "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", "key": "create_response", @@ -28395,12 +28228,12 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/create_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "eagerness", @@ -28427,20 +28260,20 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "auto" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness" + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 3" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) interrupt_response": { "kind": "HttpDeclProperty", "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", "key": "interrupt_response", @@ -28450,98 +28283,81 @@ Schema name: `RealtimeServerEventSessionCreated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/interrupt_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "alloy" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "ash" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "ballad" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "coral" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "echo" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "sage" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 6": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "shimmer" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 7": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "verse" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 8": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "marin" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 9": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 9": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cedar" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2 > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The custom voice ID, e.g. `voice_1234`.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "examples": [ - "voice_1234" - ], - "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, "(resource) responses > (model) response_input_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -28687,7 +28503,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only": { "kind": "HttpDeclProperty", "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "key": "read_only", @@ -28701,7 +28517,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names": { "kind": "HttpDeclProperty", "title": "MCP allowed tools", "docstring": "List of allowed tool names.", @@ -28720,7 +28536,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "array", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always": { "kind": "HttpDeclProperty", "title": "MCP tool filter", "docstring": "A filter object to specify which tools are allowed.\n", @@ -28738,16 +28554,16 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/0/properties/always", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never": { "kind": "HttpDeclProperty", "title": "MCP tool filter", "docstring": "A filter object to specify which tools are allowed.\n", @@ -28765,238 +28581,83 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/0/properties/never", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "always" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "never" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", - "key": "type", - "optional": false, - "nullable": false, - "default": "server_vad", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "server_vad" - } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response": { - "kind": "HttpDeclProperty", - "docstring": "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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", - "key": "create_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/create_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms": { - "kind": "HttpDeclProperty", - "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", - "key": "idle_timeout_ms", - "optional": true, - "nullable": true, - "type": { - "kind": "HttpTypeNumber" - }, - "constraints": { - "minimum": 5000, - "maximum": 30000 - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/idle_timeout_ms", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response": { - "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", - "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/interrupt_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms": { - "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", - "key": "prefix_padding_ms", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeNumber" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/prefix_padding_ms", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms": { - "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", - "key": "silence_duration_ms", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeNumber" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/silence_duration_ms", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold": { - "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", - "key": "threshold", - "optional": true, - "nullable": false, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/0", + "ident": "UnionMember0", "type": { - "kind": "HttpTypeNumber" + "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/threshold", - "deprecated": false, - "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", - "key": "type", - "optional": false, - "nullable": false, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", + "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", "types": [ { "kind": "HttpTypeLiteral", - "literal": "semantic_vad" - } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response": { - "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", - "key": "create_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" + "literal": "whisper-1" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/create_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] + { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-mini-transcribe" }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness": { - "kind": "HttpDeclProperty", - "docstring": "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.\n", - "key": "eagerness", - "optional": true, - "nullable": false, - "default": "auto", - "type": { - "kind": "HttpTypeUnion", - "types": [ { "kind": "HttpTypeLiteral", - "literal": "low" + "literal": "gpt-4o-mini-transcribe-2025-12-15" }, { "kind": "HttpTypeLiteral", - "literal": "medium" + "literal": "gpt-4o-transcribe" }, { "kind": "HttpTypeLiteral", - "literal": "high" + "literal": "gpt-4o-transcribe-diarize" }, { "kind": "HttpTypeLiteral", - "literal": "auto" + "literal": "gpt-realtime-whisper" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness", - "deprecated": false, - "schemaType": "enum", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response": { - "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", - "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/interrupt_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -29025,84 +28686,84 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "audio/pcma" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "whisper-1" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-transcribe" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-transcribe-diarize" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "server_vad" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "semantic_vad" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -29130,7 +28791,7 @@ Schema name: `RealtimeServerEventSessionCreated` "literal": "explicit" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only": { "kind": "HttpDeclProperty", "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "key": "read_only", @@ -29144,7 +28805,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names": { "kind": "HttpDeclProperty", "title": "MCP allowed tools", "docstring": "List of allowed tool names.", @@ -29163,7 +28824,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "array", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only": { "kind": "HttpDeclProperty", "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "key": "read_only", @@ -29177,7 +28838,7 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names": { "kind": "HttpDeclProperty", "title": "MCP allowed tools", "docstring": "List of allowed tool names.", @@ -29196,46 +28857,46 @@ Schema name: `RealtimeServerEventSessionCreated` "schemaType": "array", "children": [] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "server_vad" + "literal": "whisper-1" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "semantic_vad" + "literal": "gpt-4o-mini-transcribe" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "low" + "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "medium" + "literal": "gpt-4o-transcribe" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "high" + "literal": "gpt-4o-transcribe-diarize" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "auto" + "literal": "gpt-realtime-whisper" } } } @@ -29356,13 +29017,13 @@ Schema name: `RealtimeServerEventSessionUpdated` "types": [ { "kind": "HttpTypeReference", - "ident": "RealtimeSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_session_create_request > (schema)" + "ident": "RealtimeSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)" }, { "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)" + "ident": "RealtimeTranscriptionSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)" } ], "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/session" @@ -29404,54 +29065,68 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", - "ident": "RealtimeSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_session_create_request > (schema)" + "ident": "RealtimeSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)" }, "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation" ] }, "(resource) realtime > (model) session_updated_event > (schema) > (property) session > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionCreateRequest", - "$ref": "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)" + "ident": "RealtimeTranscriptionSessionCreateResponse", + "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)" }, "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema)": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA", - "ident": "RealtimeSessionCreateRequest", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA", + "ident": "RealtimeSessionCreateResponse", "type": { "kind": "HttpTypeObject", "members": [ + { + "ident": "id" + }, + { + "ident": "object" + }, { "ident": "type" }, { "ident": "audio" }, + { + "ident": "expires_at" + }, { "ident": "include" }, @@ -29467,9 +29142,6 @@ Schema name: `RealtimeServerEventSessionUpdated` { "ident": "output_modalities" }, - { - "ident": "parallel_tool_calls" - }, { "ident": "prompt" }, @@ -29490,49 +29162,63 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Realtime session object configuration.", + "docstring": "A Realtime session configuration object.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA", - "ident": "RealtimeTranscriptionSessionCreateRequest", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA", + "ident": "RealtimeTranscriptionSessionCreateResponse", "type": { "kind": "HttpTypeObject", "members": [ + { + "ident": "id" + }, + { + "ident": "object" + }, { "ident": "type" }, { "ident": "audio" }, + { + "ident": "expires_at" + }, { "ident": "include" } ] }, - "docstring": "Realtime transcription session object configuration.", + "docstring": "A Realtime transcription session configuration object.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio", - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include" ] }, "(resource) realtime > (model) session_updated_event > (schema) > (property) type > (member) 0": { @@ -29542,7 +29228,45 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "session.updated" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id": { + "kind": "HttpDeclProperty", + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object": { + "kind": "HttpDeclProperty", + "docstring": "The object type. Always `realtime.session`.", + "key": "object", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "realtime.session" + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", + "deprecated": false, + "schemaType": "enum", + "childrenParentSchema": "enum", + "children": [ + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object > (member) 0" + ] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", "key": "type", @@ -29556,39 +29280,60 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "realtime" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", "docstring": "Configuration for input and output audio.\n", "key": "audio", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioConfig", - "$ref": "(resource) realtime > (model) realtime_audio_config > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "input" + }, + { + "ident": "output" + } + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_config", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input", - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) output" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at": { + "kind": "HttpDeclProperty", + "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "key": "expires_at", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" + }, + "constraints": { + "format": "unixtime" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/expires_at", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include": { "kind": "HttpDeclProperty", "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "key": "include", @@ -29604,19 +29349,19 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "item.input_audio_transcription.logprobs" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include/items" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include/items" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", "deprecated": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include > (items) > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include > (items) > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions": { "kind": "HttpDeclProperty", "docstring": "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.\n\nNote 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.\n", "key": "instructions", @@ -29625,12 +29370,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/instructions", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/instructions", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens": { "kind": "HttpDeclProperty", "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n", "key": "max_output_tokens", @@ -29650,21 +29395,21 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model": { "kind": "HttpDeclProperty", "docstring": "The Realtime model used for this session.\n", "key": "model", @@ -29756,21 +29501,21 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "gpt-audio-mini-2025-12-15" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities": { "kind": "HttpDeclProperty", "docstring": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n", "key": "output_modalities", @@ -29793,36 +29538,22 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "audio" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities/items" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities/items" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", "deprecated": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.\n", - "key": "parallel_tool_calls", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/parallel_tool_calls", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt": { - "kind": "HttpDeclProperty", - "docstring": "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "key": "prompt", "optional": true, "nullable": true, @@ -29831,7 +29562,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "ResponsePrompt", "$ref": "(resource) responses > (model) response_prompt > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/prompt", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/prompt", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -29843,7 +29574,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) response_prompt > (schema) > (property) version" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning": { "kind": "HttpDeclProperty", "title": "Realtime reasoning configuration", "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", @@ -29855,7 +29586,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "RealtimeReasoning", "$ref": "(resource) realtime > (model) realtime_reasoning > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/reasoning", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/reasoning", "deprecated": false, "schemaType": "object", "modelImplicit": false, @@ -29865,7 +29596,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", "key": "tool_choice", @@ -29873,45 +29604,108 @@ Schema name: `RealtimeServerEventSessionUpdated` "nullable": false, "default": "auto", "type": { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeReference", + "ident": "ToolChoiceOptions", + "$ref": "(resource) responses > (model) tool_choice_options > (schema)" + }, + { "kind": "HttpTypeReference", - "ident": "RealtimeToolChoiceConfig", - "$ref": "(resource) realtime > (model) realtime_tool_choice_config > (schema)" + "ident": "ToolChoiceFunction", + "$ref": "(resource) responses > (model) tool_choice_function > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice", + { + "kind": "HttpTypeReference", + "ident": "ToolChoiceMcp", + "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", "deprecated": false, "schemaType": "union", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_tool_choice_config", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 2" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools": { "kind": "HttpDeclProperty", "docstring": "Tools available to the model.", "key": "tools", "optional": true, "nullable": false, "type": { + "kind": "HttpTypeArray", + "elementType": { + "kind": "HttpTypeUnion", + "types": [ + { "kind": "HttpTypeReference", - "ident": "RealtimeToolsConfig", - "$ref": "(resource) realtime > (model) realtime_tools_config > (schema)" + "ident": "RealtimeFunctionTool", + "$ref": "(resource) realtime > (model) realtime_function_tool > (schema)" + }, + { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "server_label" + }, + { + "ident": "type" + }, + { + "ident": "allowed_callers" + }, + { + "ident": "allowed_tools" + }, + { + "ident": "authorization" + }, + { + "ident": "connector_id" + }, + { + "ident": "defer_loading" + }, + { + "ident": "headers" + }, + { + "ident": "require_approval" + }, + { + "ident": "server_description" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", + { + "ident": "server_url" + }, + { + "ident": "tunnel_id" + } + ] + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", "deprecated": false, "schemaType": "array", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_tools_config", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing": { "kind": "HttpDeclProperty", "title": "Tracing Configuration", "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", @@ -29919,22 +29713,45 @@ Schema name: `RealtimeServerEventSessionUpdated` "optional": true, "nullable": true, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTracingConfig", - "$ref": "(resource) realtime > (model) realtime_tracing_config > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "auto" + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing", + { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "group_id" + }, + { + "ident": "metadata" + }, + { + "ident": "workflow_name" + } + ] + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing" + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", "deprecated": false, "schemaType": "union", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_tracing_config", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation": { "kind": "HttpDeclProperty", "title": "Realtime Truncation Controls", "docstring": "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.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation 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.\n\nTruncation 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.\n", @@ -29946,7 +29763,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "RealtimeTruncation", "$ref": "(resource) realtime > (model) realtime_truncation > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/truncation", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/truncation", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -29957,9 +29774,37 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The type of session to create. Always `transcription` for transcription sessions.\n", + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "key": "id", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/id", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object": { + "kind": "HttpDeclProperty", + "docstring": "The object type. Always `realtime.transcription_session`.", + "key": "object", + "optional": false, + "nullable": false, + "type": { + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/object", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "The type of session. Always `transcription` for transcription sessions.\n", "key": "type", "optional": false, "nullable": false, @@ -29971,40 +29816,58 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "transcription" } ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input and output audio.\n", + "docstring": "Configuration for input audio for the session.\n", "key": "audio", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionAudio", - "$ref": "(resource) realtime > (model) realtime_transcription_session_audio > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "input" + } + ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", + "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "key": "expires_at", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" + }, + "constraints": { + "format": "unixtime" + }, + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/expires_at", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include": { + "kind": "HttpDeclProperty", + "docstring": "Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "key": "include", "optional": true, "nullable": false, @@ -30018,111 +29881,113 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "item.input_audio_transcription.logprobs" } ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include/items" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include/items" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", "deprecated": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include > (items) > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include > (items) > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object > (member) 0": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "realtime.session" + } + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "realtime" } }, - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", "key": "input", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioConfigInput", - "$ref": "(resource) realtime > (model) realtime_audio_config_input > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "format" + }, + { + "ident": "noise_reduction" + }, + { + "ident": "transcription" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input", + { + "ident": "turn_detection" + } + ] + }, + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_config_input", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) format", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection" ] }, - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) output": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output": { "kind": "HttpDeclProperty", "key": "output", "optional": true, "nullable": false, - "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioConfigOutput", - "$ref": "(resource) realtime > (model) realtime_audio_config_output > (schema)" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output", - "deprecated": false, - "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_config_output", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice" - ] - }, - "(resource) realtime > (model) realtime_audio_config > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio", - "ident": "RealtimeAudioConfig", "type": { "kind": "HttpTypeObject", "members": [ { - "ident": "input" + "ident": "format" }, { - "ident": "output" + "ident": "speed" + }, + { + "ident": "voice" } ] }, - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output", + "deprecated": false, + "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input", - "(resource) realtime > (model) realtime_audio_config > (schema) > (property) output" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) format", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) speed", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/0", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeNumber" }, "children": [] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/1", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -30132,25 +29997,25 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "inf" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" }, "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/0", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeString" }, "children": [] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -30232,40 +30097,40 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "gpt-audio-mini-2025-12-15" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" }, "docstring": "The Realtime model used for this session.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 0", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 1", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 2", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 3", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 4", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 5", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 6", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 7", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 8", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 9", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 10", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 11", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 12", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 13", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 14", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 15", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 16", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 17", - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 18" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 7", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 8", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 9", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 10", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 11", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 12", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 13", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 14", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 15", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 16", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 17", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 18" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "text" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities > (items) > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -30370,7 +30235,7 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_prompt > (schema) > (property) id", @@ -30422,7 +30287,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -30436,7 +30301,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) tool_choice_options > (schema) > (member) 2" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -30449,7 +30314,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) tool_choice_function > (schema) > (property) type" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice > (variant) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -30463,40 +30328,85 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name" ] }, - "(resource) realtime > (model) realtime_tool_choice_config > (schema)": { + "(resource) responses > (model) tool_choice_options > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice", - "ident": "RealtimeToolChoiceConfig", + "oasRef": "#/components/schemas/ToolChoiceOptions", + "ident": "ToolChoiceOptions", "type": { "kind": "HttpTypeUnion", "types": [ { - "kind": "HttpTypeReference", - "ident": "ToolChoiceOptions", - "$ref": "(resource) responses > (model) tool_choice_options > (schema)" + "kind": "HttpTypeLiteral", + "literal": "none" }, { - "kind": "HttpTypeReference", + "kind": "HttpTypeLiteral", + "literal": "auto" + }, + { + "kind": "HttpTypeLiteral", + "literal": "required" + } + ], + "oasRef": "#/components/schemas/ToolChoiceOptions" + }, + "docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n", + "childrenParentSchema": "enum", + "children": [ + "(resource) responses > (model) tool_choice_options > (schema) > (member) 0", + "(resource) responses > (model) tool_choice_options > (schema) > (member) 1", + "(resource) responses > (model) tool_choice_options > (schema) > (member) 2" + ] + }, + "(resource) responses > (model) tool_choice_function > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/ToolChoiceFunction", "ident": "ToolChoiceFunction", - "$ref": "(resource) responses > (model) tool_choice_function > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "name" }, { - "kind": "HttpTypeReference", + "ident": "type" + } + ] + }, + "docstring": "Use this option to force the model to call a specific function.\n", + "childrenParentSchema": "object", + "children": [ + "(resource) responses > (model) tool_choice_function > (schema) > (property) name", + "(resource) responses > (model) tool_choice_function > (schema) > (property) type" + ] + }, + "(resource) responses > (model) tool_choice_mcp > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/ToolChoiceMCP", "ident": "ToolChoiceMcp", - "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" + "type": { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "server_label" + }, + { + "ident": "type" + }, + { + "ident": "name" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice" + ] }, - "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", - "childrenParentSchema": "union", + "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", + "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1", - "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2" + "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label", + "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type", + "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeReference", @@ -30511,10 +30421,10 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items/anyOf/1", - "ident": "Mcp", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items/oneOf/1", + "ident": "McpTool", "type": { "kind": "HttpTypeObject", "members": [ @@ -30556,46 +30466,55 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).\n", + "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_label", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) authorization", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) defer_loading", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) headers", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_description", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_url", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) tunnel_id" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) authorization", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) headers", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_url", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) tunnel_id" ] }, - "(resource) realtime > (model) realtime_tools_config > (schema)": { + "(resource) realtime > (model) realtime_function_tool > (schema)": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", - "ident": "RealtimeToolsConfig", + "oasRef": "#/components/schemas/RealtimeFunctionTool", + "ident": "RealtimeFunctionTool", "type": { - "kind": "HttpTypeArray", - "elementType": { - "kind": "HttpTypeReference", - "ident": "RealtimeToolsConfigUnion", - "$ref": "(resource) realtime > (model) realtime_tools_config_union > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "description" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools" + { + "ident": "name" }, - "docstring": "Tools available to the model.", - "childrenParentSchema": "union", + { + "ident": "parameters" + }, + { + "ident": "type" + } + ] + }, + "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1" + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description", + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name", + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters", + "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type" ] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/0", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", "ident": "Auto", "type": { "kind": "HttpTypeUnion", @@ -30605,17 +30524,17 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "auto" } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/0" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" }, "docstring": "Enables tracing and sets default values for tracing configuration options. Always `auto`.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0 > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0 > (member) 0" ] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1", "ident": "TracingConfiguration", "type": { "kind": "HttpTypeObject", @@ -30634,56 +30553,15 @@ Schema name: `RealtimeServerEventSessionUpdated` "docstring": "Granular configuration for tracing.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) group_id", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) metadata", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) workflow_name" - ] - }, - "(resource) realtime > (model) realtime_tracing_config > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing", - "ident": "RealtimeTracingConfig", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "auto" - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/0" - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "group_id" - }, - { - "ident": "metadata" - }, - { - "ident": "workflow_name" - } - ] - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing" - }, - "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) metadata", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) workflow_name" ] }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/0", - "ident": "RealtimeTruncationStrategy", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", + "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", "types": [ @@ -30696,7 +30574,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "disabled" } ], - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/0" + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0" }, "docstring": "The truncation strategy to use for the session. `auto` is the default truncation strategy. `disabled` will disable truncation and emit errors when the conversation exceeds the input token limit.", "childrenParentSchema": "enum", @@ -30706,17 +30584,29 @@ Schema name: `RealtimeServerEventSessionUpdated` ] }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1": { - "kind": "HttpDeclReference", + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1", + "ident": "RetentionRatioTruncation", "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTruncationRetentionRatio", - "$ref": "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "retention_ratio" }, + { + "ident": "type" + }, + { + "ident": "token_limits" + } + ] + }, + "docstring": "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.", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) retention_ratio", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits" + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio", + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type", + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits" ] }, "(resource) realtime > (model) realtime_truncation > (schema)": { @@ -30738,12 +30628,21 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "disabled" } ], - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/0" + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0" }, { - "kind": "HttpTypeReference", - "ident": "RealtimeTruncationRetentionRatio", - "$ref": "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "retention_ratio" + }, + { + "ident": "type" + }, + { + "ident": "token_limits" + } + ] } ], "oasRef": "#/components/schemas/RealtimeTruncation" @@ -30755,62 +30654,54 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "transcription" } }, - "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", "key": "input", "optional": true, "nullable": false, - "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionAudioInput", - "$ref": "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema)" - }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input", - "deprecated": false, - "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio", - "ident": "RealtimeTranscriptionSessionAudio", "type": { "kind": "HttpTypeObject", "members": [ { - "ident": "input" + "ident": "format" + }, + { + "ident": "noise_reduction" + }, + { + "ident": "transcription" + }, + { + "ident": "turn_detection" } ] }, - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input", + "deprecated": false, + "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) format", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection" ] }, - "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", "docstring": "The format of the input audio.", "key": "format", @@ -30821,7 +30712,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/format", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/format", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -30833,7 +30724,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", "key": "noise_reduction", @@ -30847,39 +30738,45 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction > (property) type" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "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](https://platform.openai.com/docs/api-reference/audio/createTranscription) 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.\n", + "docstring": "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](/docs/api-reference/audio/createTranscription) 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.\n", "key": "transcription", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "AudioTranscription", - "$ref": "(resource) realtime > (model) audio_transcription > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "language" + }, + { + "ident": "model" + }, + { + "ident": "prompt" + } + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) audio_transcription", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", - "(resource) realtime > (model) audio_transcription > (schema) > (property) language", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model", - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", "title": "Realtime Turn Detection", "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", @@ -30887,51 +30784,64 @@ Schema name: `RealtimeServerEventSessionUpdated` "optional": true, "nullable": true, "type": { - "kind": "HttpTypeReference", - "ident": "RealtimeAudioInputTurnDetection", - "$ref": "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema)" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeObject", + "members": [ + { + "ident": "type" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, - "schemaType": "union", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_audio_input_turn_detection", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1" + { + "ident": "create_response" + }, + { + "ident": "idle_timeout_ms" + }, + { + "ident": "interrupt_response" + }, + { + "ident": "prefix_padding_ms" + }, + { + "ident": "silence_duration_ms" + }, + { + "ident": "threshold" + } ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input", - "ident": "RealtimeAudioConfigInput", - "type": { + { "kind": "HttpTypeObject", "members": [ { - "ident": "format" + "ident": "type" }, { - "ident": "noise_reduction" + "ident": "create_response" }, { - "ident": "transcription" + "ident": "eagerness" }, { - "ident": "turn_detection" + "ident": "interrupt_response" } ] + } + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection" }, - "childrenParentSchema": "object", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, + "schemaType": "union", + "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1" ] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) format": { "kind": "HttpDeclProperty", "docstring": "The format of the output audio.", "key": "format", @@ -30942,7 +30852,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/format", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/format", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -30954,7 +30864,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) speed": { "kind": "HttpDeclProperty", "docstring": "The speed of the model's spoken response as a multiple of the original speed.\n1.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.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n", "key": "speed", @@ -30968,15 +30878,14 @@ Schema name: `RealtimeServerEventSessionUpdated` "maximum": 1.5, "minimum": 0.25 }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/speed", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/speed", "deprecated": false, "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice": { "kind": "HttpDeclProperty", - "title": "Voice", - "docstring": "The voice the model uses to respond. Supported built-in voices are\n`alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`,\n`marin`, and `cedar`. You may also provide a custom voice object with\nan `id`, for example `{ \"id\": \"voice_1234\" }`. Voice cannot be changed\nduring the session once the model has responded with audio at least once.\nWe recommend `marin` and `cedar` for best quality.\n", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "key": "voice", "optional": true, "nullable": false, @@ -31032,187 +30941,156 @@ Schema name: `RealtimeServerEventSessionUpdated` } ], "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - } - ] } ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice" + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice", + "examples": [ + "ash" + ], + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 0", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2" - ] - }, - "(resource) realtime > (model) realtime_audio_config_output > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output", - "ident": "RealtimeAudioConfigOutput", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "format" - }, - { - "ident": "speed" - }, - { - "ident": "voice" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1" ] }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "inf" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-1.5" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2.1" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2.1-mini" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-2025-08-28" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 6": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 7": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview-2024-10-01" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 8": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview-2024-12-17" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 9": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 9": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-realtime-preview-2025-06-03" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 10": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 10": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-realtime-preview" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 11": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 11": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-realtime-preview-2024-12-17" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 12": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 12": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-mini" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 13": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 13": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-mini-2025-10-06" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 14": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 14": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-mini-2025-12-15" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 15": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 15": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-audio-1.5" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 16": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 16": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 17": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 17": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-10-06" } }, - "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 18": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 18": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -31221,7 +31099,7 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties/anyOf/0", + "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties/oneOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeString" @@ -31326,7 +31204,7 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision).", + "docstring": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_image > (schema) > (property) detail", @@ -31474,36 +31352,6 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "required" } }, - "(resource) responses > (model) tool_choice_options > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ToolChoiceOptions", - "ident": "ToolChoiceOptions", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "none" - }, - { - "kind": "HttpTypeLiteral", - "literal": "auto" - }, - { - "kind": "HttpTypeLiteral", - "literal": "required" - } - ], - "oasRef": "#/components/schemas/ToolChoiceOptions" - }, - "docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n", - "childrenParentSchema": "enum", - "children": [ - "(resource) responses > (model) tool_choice_options > (schema) > (member) 0", - "(resource) responses > (model) tool_choice_options > (schema) > (member) 1", - "(resource) responses > (model) tool_choice_options > (schema) > (member) 2" - ] - }, "(resource) responses > (model) tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", "docstring": "The name of the function to call.", @@ -31542,28 +31390,6 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) tool_choice_function > (schema) > (property) type > (member) 0" ] }, - "(resource) responses > (model) tool_choice_function > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ToolChoiceFunction", - "ident": "ToolChoiceFunction", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "name" - }, - { - "ident": "type" - } - ] - }, - "docstring": "Use this option to force the model to call a specific function.\n", - "childrenParentSchema": "object", - "children": [ - "(resource) responses > (model) tool_choice_function > (schema) > (property) name", - "(resource) responses > (model) tool_choice_function > (schema) > (property) type" - ] - }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": { "kind": "HttpDeclProperty", "docstring": "The label of the MCP server to use.\n", @@ -31616,32 +31442,6 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "string", "children": [] }, - "(resource) responses > (model) tool_choice_mcp > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/ToolChoiceMCP", - "ident": "ToolChoiceMcp", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "server_label" - }, - { - "ident": "type" - }, - { - "ident": "name" - } - ] - }, - "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", - "childrenParentSchema": "object", - "children": [ - "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label", - "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type", - "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name" - ] - }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description": { "kind": "HttpDeclProperty", "docstring": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n", @@ -31708,36 +31508,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_function_tool > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeFunctionTool", - "ident": "RealtimeFunctionTool", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "description" - }, - { - "ident": "name" - }, - { - "ident": "parameters" - }, - { - "ident": "type" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description", - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name", - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters", - "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type" - ] - }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_label": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label": { "kind": "HttpDeclProperty", "docstring": "A label for this MCP server, used to identify it in tool calls.\n", "key": "server_label", @@ -31751,7 +31522,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "docstring": "The type of the MCP tool. Always `mcp`.", "key": "type", @@ -31772,10 +31543,10 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers": { "kind": "HttpDeclProperty", "docstring": "The tool invocation context(s).", "key": "allowed_callers", @@ -31804,11 +31575,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "array", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 1" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools": { "kind": "HttpDeclProperty", "docstring": "List of allowed tool names or a filter object.\n", "key": "allowed_tools", @@ -31822,7 +31593,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "elementType": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/0" + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" }, { "kind": "HttpTypeObject", @@ -31843,11 +31614,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) authorization": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) authorization": { "kind": "HttpDeclProperty", "docstring": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n", "key": "authorization", @@ -31861,9 +31632,9 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id": { "kind": "HttpDeclProperty", - "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", + "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", "key": "connector_id", "optional": true, "nullable": false, @@ -31910,17 +31681,17 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 1", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 2", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 3", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 4", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 5", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 6", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 7" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 7" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) defer_loading": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading": { "kind": "HttpDeclProperty", "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", "key": "defer_loading", @@ -31934,7 +31705,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) headers": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) headers": { "kind": "HttpDeclProperty", "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", "key": "headers", @@ -31958,7 +31729,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "map", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval": { "kind": "HttpDeclProperty", "docstring": "Specify which of the MCP server's tools require approval.", "key": "require_approval", @@ -31991,7 +31762,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "never" } ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/1" + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" } ], "oasRef": "#/components/schemas/MCPTool/properties/require_approval" @@ -32001,11 +31772,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_description": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description": { "kind": "HttpDeclProperty", "docstring": "Optional description of the MCP server, used to provide more context.\n", "key": "server_description", @@ -32019,7 +31790,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_url": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_url": { "kind": "HttpDeclProperty", "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", "key": "server_url", @@ -32036,7 +31807,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) tunnel_id": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) tunnel_id": { "kind": "HttpDeclProperty", "docstring": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.\n", "key": "tunnel_id", @@ -32050,77 +31821,14 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items", - "ident": "RealtimeToolsConfigUnion", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeReference", - "ident": "RealtimeFunctionTool", - "$ref": "(resource) realtime > (model) realtime_function_tool > (schema)" - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "server_label" - }, - { - "ident": "type" - }, - { - "ident": "allowed_callers" - }, - { - "ident": "allowed_tools" - }, - { - "ident": "authorization" - }, - { - "ident": "connector_id" - }, - { - "ident": "defer_loading" - }, - { - "ident": "headers" - }, - { - "ident": "require_approval" - }, - { - "ident": "server_description" - }, - { - "ident": "server_url" - }, - { - "ident": "tunnel_id" - } - ] - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items" - }, - "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).\n", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1" - ] - }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "auto" } }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) group_id": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id": { "kind": "HttpDeclProperty", "docstring": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n", "key": "group_id", @@ -32129,12 +31837,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1/properties/group_id", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/group_id", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) metadata": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) metadata": { "kind": "HttpDeclProperty", "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", "key": "metadata", @@ -32143,12 +31851,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1/properties/metadata", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/metadata", "deprecated": false, "schemaType": "unknown", "children": [] }, - "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) workflow_name": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) workflow_name": { "kind": "HttpDeclProperty", "docstring": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n", "key": "workflow_name", @@ -32157,7 +31865,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/anyOf/1/properties/workflow_name", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/workflow_name", "deprecated": false, "schemaType": "string", "children": [] @@ -32176,7 +31884,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "disabled" } }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) retention_ratio": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "retention_ratio", @@ -32189,12 +31897,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/retention_ratio", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", "deprecated": false, "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "docstring": "Use retention ratio truncation.", "key": "type", @@ -32208,17 +31916,17 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "retention_ratio" } ], - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/type" + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/type", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type > (member) 0" + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits": { "kind": "HttpDeclProperty", "docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.", "key": "token_limits", @@ -32232,41 +31940,15 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/token_limits", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits > (property) post_instructions" + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions" ] }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1", - "ident": "RealtimeTruncationRetentionRatio", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "retention_ratio" - }, - { - "ident": "type" - }, - { - "ident": "token_limits" - } - ] - }, - "docstring": "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.", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) retention_ratio", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type", - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "key": "format", @@ -32277,7 +31959,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/format", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/format", "deprecated": false, "schemaType": "union", "modelImplicit": false, @@ -32289,9 +31971,9 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", + "docstring": "Configuration for input audio noise reduction.\n", "key": "noise_reduction", "optional": true, "nullable": false, @@ -32303,94 +31985,72 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction > (property) type" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "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](https://platform.openai.com/docs/api-reference/audio/createTranscription) 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.\n", + "docstring": "Configuration of the transcription model.\n", "key": "transcription", "optional": true, "nullable": false, "type": { - "kind": "HttpTypeReference", - "ident": "AudioTranscription", - "$ref": "(resource) realtime > (model) audio_transcription > (schema)" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "language" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", + { + "ident": "model" + }, + { + "ident": "prompt" + } + ] + }, + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", "deprecated": false, "schemaType": "object", - "modelImplicit": false, - "modelPath": "(resource) realtime > (model) audio_transcription", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", - "(resource) realtime > (model) audio_transcription > (schema) > (property) language", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model", - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", - "title": "Realtime Turn Detection", - "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "key": "turn_detection", "optional": true, "nullable": true, "type": { "kind": "HttpTypeReference", - "ident": "RealtimeTranscriptionSessionAudioInputTurnDetection", - "$ref": "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema)" + "ident": "RealtimeTranscriptionSessionTurnDetection", + "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", "deprecated": false, - "schemaType": "union", + "schemaType": "object", "modelImplicit": false, - "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input", - "ident": "RealtimeTranscriptionSessionAudioInput", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "format" - }, - { - "ident": "noise_reduction" - }, - { - "ident": "transcription" - }, - { - "ident": "turn_detection" - } - ] - }, + "modelPath": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription", - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type" ] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "AudioPCM", + "ident": "PCMAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -32412,7 +32072,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "AudioPCMU", + "ident": "PCMUAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -32430,7 +32090,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "AudioPCMA", + "ident": "PCMAAudioFormat", "type": { "kind": "HttpTypeObject", "members": [ @@ -32490,7 +32150,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2" ] }, - "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "type", @@ -32501,7 +32161,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", "deprecated": false, "schemaType": "enum", "modelImplicit": false, @@ -32512,67 +32172,23 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1" ] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay": { - "kind": "HttpDeclProperty", - "docstring": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.\n", - "key": "delay", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "minimal" - }, - { - "kind": "HttpTypeLiteral", - "literal": "low" - }, - { - "kind": "HttpTypeLiteral", - "literal": "medium" - }, - { - "kind": "HttpTypeLiteral", - "literal": "high" - }, - { - "kind": "HttpTypeLiteral", - "literal": "xhigh" - } - ], - "oasRef": "#/components/schemas/AudioTranscription/properties/delay" - }, - "oasRef": "#/components/schemas/AudioTranscription/properties/delay", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 0", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 1", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 2", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 3", - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 4" - ] - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) language": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { "kind": "HttpDeclProperty", - "docstring": "The language of the input audio. Supplying the input language in\n[ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`) format\nwill improve accuracy and latency.\n", + "docstring": "The language of the input audio.\n", "key": "language", "optional": true, "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscription/properties/language", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { "kind": "HttpDeclProperty", - "docstring": "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`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.\n", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "key": "model", "optional": true, "nullable": false, @@ -32610,66 +32226,37 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "gpt-realtime-whisper" } ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" } ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" }, - "oasRef": "#/components/schemas/AudioTranscription/properties/model", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", "deprecated": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 0", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1" ] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "An optional text to guide the model's style or continue a previous audio\nsegment.\nFor `whisper-1`, the [prompt is a list of keywords](https://platform.openai.com/docs/guides/speech-to-text#prompting).\nFor `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the prompt is a free text string, for example \"expect words related to technology\".\nPrompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.\n", + "docstring": "The prompt configured for input audio transcription, when present.\n", "key": "prompt", "optional": true, "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscription/properties/prompt", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", "deprecated": false, "schemaType": "string", "children": [] }, - "(resource) realtime > (model) audio_transcription > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AudioTranscription", - "ident": "AudioTranscription", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "delay" - }, - { - "ident": "language" - }, - { - "ident": "model" - }, - { - "ident": "prompt" - } - ] - }, - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", - "(resource) realtime > (model) audio_transcription > (schema) > (property) language", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model", - "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" - ] - }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0", "ident": "ServerVad", "type": { "kind": "HttpTypeObject", @@ -32700,18 +32287,18 @@ Schema name: `RealtimeServerEventSessionUpdated` "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) create_response", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) idle_timeout_ms", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) interrupt_response", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) prefix_padding_ms", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) silence_duration_ms", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) threshold" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1", "ident": "SemanticVad", "type": { "kind": "HttpTypeObject", @@ -32733,73 +32320,13 @@ Schema name: `RealtimeServerEventSessionUpdated` "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response" - ] - }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "ident": "RealtimeAudioInputTurnDetection", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "create_response" - }, - { - "ident": "idle_timeout_ms" - }, - { - "ident": "interrupt_response" - }, - { - "ident": "prefix_padding_ms" - }, - { - "ident": "silence_duration_ms" - }, - { - "ident": "threshold" - } - ] - }, - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" - }, - { - "ident": "create_response" - }, - { - "ident": "eagerness" - }, - { - "ident": "interrupt_response" - } - ] - } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection" - }, - "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", - "childrenParentSchema": "union", - "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) create_response", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) interrupt_response" ] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/0", "ident": "UnionMember0", @@ -32808,7 +32335,7 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "children": [] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "ident": "UnionMember1", @@ -32858,36 +32385,19 @@ Schema name: `RealtimeServerEventSessionUpdated` ], "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" }, + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 0", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 1", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 2", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 3", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 4", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 5", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 6", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 7", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 8", - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 9" - ] - }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1", - "ident": "ID", - "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "id" - } - ] - }, - "docstring": "Custom voice reference.", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2 > (property) id" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 7", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 8", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 9" ] }, "(resource) responses > (model) response_input_text > (schema) > (property) text": { @@ -33232,44 +32742,44 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "function" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "mcp" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "direct" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "programmatic" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/0", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "ident": "McpAllowedTools", "type": { "kind": "HttpTypeArray", "elementType": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/0" + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" }, "docstring": "A string array of allowed tool names", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/anyOf/1", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/1", "ident": "McpToolFilter", "type": { "kind": "HttpTypeObject", @@ -33285,69 +32795,69 @@ Schema name: `RealtimeServerEventSessionUpdated` "docstring": "A filter object to specify which tools are allowed.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_dropbox" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_gmail" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_googlecalendar" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_googledrive" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_microsoftteams" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_outlookcalendar" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 6": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_outlookemail" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 7": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "connector_sharepoint" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/0", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0", "ident": "McpToolApprovalFilter", "type": { "kind": "HttpTypeObject", @@ -33363,13 +32873,13 @@ Schema name: `RealtimeServerEventSessionUpdated` "docstring": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/1", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "ident": "McpToolApprovalSetting", "type": { "kind": "HttpTypeUnion", @@ -33383,23 +32893,23 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "never" } ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/1" + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" }, "docstring": "Specify a single approval policy for all tools. One of `always` or\n`never`. When set to `always`, all tools will require approval. When\nset to `never`, all tools will not require approval.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1" ] }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) type > (member) 0": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "retention_ratio" } }, - "(resource) realtime > (model) realtime_truncation_retention_ratio > (schema) > (property) token_limits > (property) post_instructions": { + "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions": { "kind": "HttpDeclProperty", "docstring": "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.", "key": "post_instructions", @@ -33411,12 +32921,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/RealtimeTruncation/anyOf/1/properties/token_limits/properties/post_instructions", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "type", @@ -33427,7 +32937,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", "deprecated": false, "schemaType": "enum", "modelImplicit": false, @@ -33438,100 +32948,151 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0", - "ident": "ServerVad", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { + "kind": "HttpDeclProperty", + "docstring": "The language of the input audio.\n", + "key": "language", + "optional": true, + "nullable": false, "type": { - "kind": "HttpTypeObject", - "members": [ + "kind": "HttpTypeString" + }, + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", + "deprecated": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { + "kind": "HttpDeclProperty", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", + "key": "model", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeUnion", + "types": [ { - "ident": "type" + "kind": "HttpTypeString" }, { - "ident": "create_response" + "kind": "HttpTypeUnion", + "types": [ + { + "kind": "HttpTypeLiteral", + "literal": "whisper-1" }, { - "ident": "idle_timeout_ms" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-mini-transcribe" }, { - "ident": "interrupt_response" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-mini-transcribe-2025-12-15" }, { - "ident": "prefix_padding_ms" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe" }, { - "ident": "silence_duration_ms" + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe-diarize" }, { - "ident": "threshold" + "kind": "HttpTypeLiteral", + "literal": "gpt-realtime-whisper" } - ] + ], + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + } + ], + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" }, - "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", - "childrenParentSchema": "object", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", + "deprecated": false, + "schemaType": "union", + "childrenParentSchema": "union", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1", - "ident": "SemanticVad", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { + "kind": "HttpDeclProperty", + "docstring": "The prompt configured for input audio transcription, when present.\n", + "key": "prompt", + "optional": true, + "nullable": false, "type": { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" + "kind": "HttpTypeString" }, - { - "ident": "create_response" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", + "deprecated": false, + "schemaType": "string", + "children": [] }, - { - "ident": "eagerness" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms": { + "kind": "HttpDeclProperty", + "docstring": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", + "key": "prefix_padding_ms", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" }, - { - "ident": "interrupt_response" - } - ] + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/prefix_padding_ms", + "deprecated": false, + "schemaType": "integer", + "children": [] }, - "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", - "childrenParentSchema": "object", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response" - ] + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms": { + "kind": "HttpDeclProperty", + "docstring": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", + "key": "silence_duration_ms", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeNumber" }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema)": { - "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "ident": "RealtimeTranscriptionSessionAudioInputTurnDetection", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/silence_duration_ms", + "deprecated": false, + "schemaType": "integer", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold": { + "kind": "HttpDeclProperty", + "docstring": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", + "key": "threshold", + "optional": true, + "nullable": false, "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeObject", - "members": [ - { - "ident": "type" + "kind": "HttpTypeNumber" }, - { - "ident": "create_response" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/threshold", + "deprecated": false, + "schemaType": "number", + "children": [] }, - { - "ident": "idle_timeout_ms" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type": { + "kind": "HttpDeclProperty", + "docstring": "Type of turn detection, only `server_vad` is currently supported.\n", + "key": "type", + "optional": true, + "nullable": false, + "type": { + "kind": "HttpTypeString" }, - { - "ident": "interrupt_response" + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/type", + "deprecated": false, + "schemaType": "string", + "children": [] }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "ident": "RealtimeTranscriptionSessionTurnDetection", + "type": { + "kind": "HttpTypeObject", + "members": [ { "ident": "prefix_padding_ms" }, @@ -33540,34 +33101,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, { "ident": "threshold" - } - ] }, - { - "kind": "HttpTypeObject", - "members": [ { "ident": "type" - }, - { - "ident": "create_response" - }, - { - "ident": "eagerness" - }, - { - "ident": "interrupt_response" } ] - } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection" }, - "docstring": "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.\n\nServer 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.\n\nSemantic 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.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", - "childrenParentSchema": "union", + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", + "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type" ] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { @@ -33705,53 +33251,18 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1" ] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 0": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "minimal" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 1": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "low" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 2": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "medium" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 3": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "high" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 4": { - "kind": "HttpDeclReference", - "type": { - "kind": "HttpTypeLiteral", - "literal": "xhigh" - } - }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/0", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/0", "ident": "UnionMember0", "type": { "kind": "HttpTypeString" }, "children": [] }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", @@ -33781,20 +33292,20 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "gpt-realtime-whisper" } ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" }, - "docstring": "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`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`. Use `gpt-4o-transcribe-diarize` when you need diarization with speaker labels.\n", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 0", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 1", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 2", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 3", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 4", - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", "key": "type", @@ -33809,17 +33320,17 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "server_vad" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type" + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) create_response": { "kind": "HttpDeclProperty", "docstring": "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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "key": "create_response", @@ -33829,12 +33340,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/create_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) idle_timeout_ms": { "kind": "HttpDeclProperty", "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", "key": "idle_timeout_ms", @@ -33847,12 +33358,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "minimum": 5000, "maximum": 30000 }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/idle_timeout_ms", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) interrupt_response": { "kind": "HttpDeclProperty", "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "key": "interrupt_response", @@ -33862,12 +33373,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/interrupt_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) prefix_padding_ms": { "kind": "HttpDeclProperty", "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "key": "prefix_padding_ms", @@ -33876,12 +33387,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/prefix_padding_ms", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) silence_duration_ms": { "kind": "HttpDeclProperty", "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", "key": "silence_duration_ms", @@ -33890,12 +33401,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/silence_duration_ms", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", "deprecated": false, "schemaType": "integer", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) threshold": { "kind": "HttpDeclProperty", "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", "key": "threshold", @@ -33904,12 +33415,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/threshold", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", "deprecated": false, "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", "key": "type", @@ -33923,17 +33434,17 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "semantic_vad" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type" + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type > (member) 0" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) create_response": { "kind": "HttpDeclProperty", "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", "key": "create_response", @@ -33943,12 +33454,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/create_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness": { "kind": "HttpDeclProperty", "docstring": "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.\n", "key": "eagerness", @@ -33975,20 +33486,20 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "auto" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness" + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", "deprecated": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2", - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 3" ] }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) interrupt_response": { "kind": "HttpDeclProperty", "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", "key": "interrupt_response", @@ -33998,98 +33509,81 @@ Schema name: `RealtimeServerEventSessionUpdated` "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/interrupt_response", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", "deprecated": false, "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "alloy" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "ash" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "ballad" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "coral" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "echo" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "sage" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 6": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 6": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "shimmer" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 7": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "verse" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 8": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 8": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "marin" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 9": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 9": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "cedar" } }, - "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2 > (property) id": { - "kind": "HttpDeclProperty", - "docstring": "The custom voice ID, e.g. `voice_1234`.", - "key": "id", - "optional": false, - "nullable": false, - "type": { - "kind": "HttpTypeString" - }, - "examples": [ - "voice_1234" - ], - "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id", - "deprecated": false, - "schemaType": "string", - "children": [] - }, "(resource) responses > (model) response_input_text > (schema) > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -34235,7 +33729,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only": { "kind": "HttpDeclProperty", "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "key": "read_only", @@ -34249,7 +33743,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names": { "kind": "HttpDeclProperty", "title": "MCP allowed tools", "docstring": "List of allowed tool names.", @@ -34268,7 +33762,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "array", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always": { "kind": "HttpDeclProperty", "title": "MCP tool filter", "docstring": "A filter object to specify which tools are allowed.\n", @@ -34286,16 +33780,16 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/0/properties/always", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never": { "kind": "HttpDeclProperty", "title": "MCP tool filter", "docstring": "A filter object to specify which tools are allowed.\n", @@ -34313,238 +33807,83 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/anyOf/0/properties/never", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", "deprecated": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only", - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names" ] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "always" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "never" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", - "key": "type", - "optional": false, - "nullable": false, - "default": "server_vad", - "type": { - "kind": "HttpTypeUnion", - "types": [ - { - "kind": "HttpTypeLiteral", - "literal": "server_vad" - } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response": { - "kind": "HttpDeclProperty", - "docstring": "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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", - "key": "create_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/create_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms": { - "kind": "HttpDeclProperty", - "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", - "key": "idle_timeout_ms", - "optional": true, - "nullable": true, - "type": { - "kind": "HttpTypeNumber" - }, - "constraints": { - "minimum": 5000, - "maximum": 30000 - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/idle_timeout_ms", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response": { - "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (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.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", - "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/interrupt_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms": { - "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", - "key": "prefix_padding_ms", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeNumber" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/prefix_padding_ms", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms": { - "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", - "key": "silence_duration_ms", - "optional": true, - "nullable": false, - "type": { - "kind": "HttpTypeNumber" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/silence_duration_ms", - "deprecated": false, - "schemaType": "integer", - "children": [] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold": { - "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", - "key": "threshold", - "optional": true, - "nullable": false, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 0": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/0", + "ident": "UnionMember0", "type": { - "kind": "HttpTypeNumber" + "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/0/properties/threshold", - "deprecated": false, - "schemaType": "number", "children": [] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type": { - "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", - "key": "type", - "optional": false, - "nullable": false, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", + "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", "types": [ { "kind": "HttpTypeLiteral", - "literal": "semantic_vad" - } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/type", - "deprecated": false, - "schemaType": "enum", - "childrenParentSchema": "enum", - "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0" - ] - }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response": { - "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", - "key": "create_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" + "literal": "whisper-1" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/create_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] + { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-mini-transcribe" }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness": { - "kind": "HttpDeclProperty", - "docstring": "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.\n", - "key": "eagerness", - "optional": true, - "nullable": false, - "default": "auto", - "type": { - "kind": "HttpTypeUnion", - "types": [ { "kind": "HttpTypeLiteral", - "literal": "low" + "literal": "gpt-4o-mini-transcribe-2025-12-15" }, { "kind": "HttpTypeLiteral", - "literal": "medium" + "literal": "gpt-4o-transcribe" }, { "kind": "HttpTypeLiteral", - "literal": "high" + "literal": "gpt-4o-transcribe-diarize" }, { "kind": "HttpTypeLiteral", - "literal": "auto" + "literal": "gpt-realtime-whisper" } ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness" + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/eagerness", - "deprecated": false, - "schemaType": "enum", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2", - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" ] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response": { - "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", - "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, - "type": { - "kind": "HttpTypeBoolean" - }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/anyOf/1/properties/interrupt_response", - "deprecated": false, - "schemaType": "boolean", - "children": [] - }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0": { "kind": "HttpDeclReference", "type": { @@ -34573,84 +33912,84 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "audio/pcma" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "whisper-1" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-transcribe" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 4": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-4o-transcribe-diarize" } }, - "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "server_vad" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "semantic_vad" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "low" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "medium" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", "literal": "high" } }, - "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -34678,7 +34017,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "literal": "explicit" } }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only": { "kind": "HttpDeclProperty", "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "key": "read_only", @@ -34692,7 +34031,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names": { "kind": "HttpDeclProperty", "title": "MCP allowed tools", "docstring": "List of allowed tool names.", @@ -34711,7 +34050,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "array", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only": { "kind": "HttpDeclProperty", "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "key": "read_only", @@ -34725,7 +34064,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "boolean", "children": [] }, - "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names": { + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names": { "kind": "HttpDeclProperty", "title": "MCP allowed tools", "docstring": "List of allowed tool names.", @@ -34744,46 +34083,46 @@ Schema name: `RealtimeServerEventSessionUpdated` "schemaType": "array", "children": [] }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "server_vad" + "literal": "whisper-1" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 1": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "semantic_vad" + "literal": "gpt-4o-mini-transcribe" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "low" + "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "medium" + "literal": "gpt-4o-transcribe" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "high" + "literal": "gpt-4o-transcribe-diarize" } }, - "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3": { + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "auto" + "literal": "gpt-realtime-whisper" } } } @@ -34875,7 +34214,7 @@ Schema name: `RealtimeServerEventSessionUpdated` **WebRTC/SIP Only:** Emitted when the server begins streaming audio to the client. This event is emitted after an audio content part has been added (`response.content_part.added`) to the response. -[Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). +[Learn more](https://developers.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). ### Schema @@ -34901,7 +34240,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "**WebRTC/SIP Only:** Emitted when the server begins streaming audio to the client. This event is\nemitted after an audio content part has been added (`response.content_part.added`)\nto the response.\n[Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", + "docstring": "**WebRTC/SIP Only:** Emitted when the server begins streaming audio to the client. This event is\nemitted after an audio content part has been added (`response.content_part.added`)\nto the response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 31 > (property) event_id", @@ -34982,7 +34321,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( **WebRTC/SIP Only:** Emitted when the output audio buffer has been completely drained on the server, and no more audio is forthcoming. This event is emitted after the full response data has been sent to the client (`response.done`). -[Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). +[Learn more](https://developers.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). ### Schema @@ -35008,7 +34347,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer has been completely drained on the server,\nand no more audio is forthcoming. This event is emitted after the full response\ndata has been sent to the client (`response.done`).\n[Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", + "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer has been completely drained on the server,\nand no more audio is forthcoming. This event is emitted after the full response\ndata has been sent to the client (`response.done`).\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 32 > (property) event_id", @@ -35090,7 +34429,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( mode when the user has interrupted (`input_audio_buffer.speech_started`), or when the client has emitted the `output_audio_buffer.clear` event to manually cut off the current audio response. -[Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). +[Learn more](https://developers.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc). ### Schema @@ -35116,7 +34455,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer is cleared. This happens either in VAD\nmode when the user has interrupted (`input_audio_buffer.speech_started`),\nor when the client has emitted the `output_audio_buffer.clear` event to manually\ncut off the current audio response.\n[Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", + "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer is cleared. This happens either in VAD\nmode when the user has interrupted (`input_audio_buffer.speech_started`),\nor when the client has emitted the `output_audio_buffer.clear` event to manually\ncut off the current audio response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) event_id",