diff --git a/en/resources/realtime/client-events.md b/en/resources/realtime/client-events.md index c4d73261..ccb52384 100644 --- a/en/resources/realtime/client-events.md +++ b/en/resources/realtime/client-events.md @@ -1,5 +1,7 @@ # Realtime client events +> For the complete documentation index, see [llms.txt](/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL. + These are events that the OpenAI Realtime WebSocket server will accept from the client. ## session.update @@ -23,6 +25,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) session_update_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate", + "docstring": "Send this event to update the session’s configuration.\nThe client may send this event at any time to update any field\nexcept for `voice` and `model`. `voice` can be updated only if there have been no other audio outputs yet.\n\nWhen the server receives a `session.update`, it will respond\nwith a `session.updated` event showing the full, effective configuration.\nOnly the fields that are present in the `session.update` are updated. To clear a field like\n`instructions`, pass an empty string. To clear a field like `tools`, pass an empty array.\nTo clear a field like `turn_detection`, pass `null`.\n", "ident": "SessionUpdateEvent", "type": { "kind": "HttpTypeObject", @@ -38,7 +41,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Send this event to update the session’s configuration.\nThe client may send this event at any time to update any field\nexcept for `voice` and `model`. `voice` can be updated only if there have been no other audio outputs yet.\n\nWhen the server receives a `session.update`, it will respond\nwith a `session.updated` event showing the full, effective configuration.\nOnly the fields that are present in the `session.update` are updated. To clear a field like\n`instructions`, pass an empty string. To clear a field like `tools`, pass an empty array.\nTo clear a field like `turn_detection`, pass `null`.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) session_update_event > (schema) > (property) session", @@ -48,12 +50,13 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) session_update_event > (schema) > (property) session": { "kind": "HttpDeclProperty", - "docstring": "Update the Realtime session. Choose either a realtime\nsession or a transcription session.\n", + "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/session", + "deprecated": false, "key": "session", - "optional": false, - "nullable": false, + "docstring": "Update the Realtime session. Choose either a realtime\nsession or a transcription session.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/session", "types": [ { "kind": "HttpTypeReference", @@ -65,11 +68,10 @@ Schema name: `RealtimeClientEventSessionUpdate` "ident": "RealtimeTranscriptionSessionCreateRequest", "$ref": "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/session" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/session", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -79,22 +81,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) session_update_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `session.update`.", + "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `session.update`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "session.update" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -103,18 +105,18 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) session_update_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event. This is an arbitrary string that a client may assign. It will be passed back if there is an error with the event, but the corresponding `session.updated` event will not include it.", + "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event. This is an arbitrary string that a client may assign. It will be passed back if there is an error with the event, but the corresponding `session.updated` event will not include it.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -160,6 +162,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_session_create_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA", + "docstring": "Realtime session object configuration.", "ident": "RealtimeSessionCreateRequest", "type": { "kind": "HttpTypeObject", @@ -208,7 +211,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Realtime session object configuration.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type", @@ -230,6 +232,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA", + "docstring": "Realtime transcription session object configuration.", "ident": "RealtimeTranscriptionSessionCreateRequest", "type": { "kind": "HttpTypeObject", @@ -245,7 +248,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Realtime transcription session object configuration.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type", @@ -262,22 +264,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -286,19 +288,19 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for input and output audio.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioConfig", "$ref": "(resource) realtime > (model) realtime_audio_config > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_audio_config", "childrenParentSchema": "object", "children": [ @@ -308,26 +310,26 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include", + "deprecated": false, "key": "include", - "optional": true, - "nullable": false, + "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include/items", "types": [ { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/include", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -336,45 +338,45 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/instructions", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens", + "deprecated": false, "key": "max_output_tokens", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens", "types": [ { "kind": "HttpTypeNumber" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -384,18 +386,20 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The Realtime model used for this session.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The Realtime model used for this session.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -473,14 +477,12 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-12-15" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -490,17 +492,16 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities", + "deprecated": false, "key": "output_modalities", - "optional": true, - "nullable": false, - "default": [ - "audio" - ], + "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", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities/items", "types": [ { "kind": "HttpTypeLiteral", @@ -510,13 +511,14 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "audio" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/output_modalities", - "deprecated": false, + "default": [ + "audio" + ], + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -526,33 +528,33 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": true, - "nullable": false, + "docstring": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/parallel_tool_calls", - "deprecated": false, + "optional": true, + "nullable": 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](/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": true, + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "type": { "kind": "HttpTypeReference", "ident": "ResponsePrompt", "$ref": "(resource) responses > (model) response_prompt > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/prompt", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) responses > (model) response_prompt", "childrenParentSchema": "object", "children": [ @@ -563,20 +565,20 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning": { "kind": "HttpDeclProperty", - "title": "Realtime reasoning configuration", - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/reasoning", + "deprecated": false, "key": "reasoning", - "optional": true, - "nullable": false, + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "title": "Realtime reasoning configuration", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoning", "$ref": "(resource) realtime > (model) realtime_reasoning > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/reasoning", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_reasoning", "childrenParentSchema": "object", "children": [ @@ -585,20 +587,20 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeToolChoiceConfig", "$ref": "(resource) realtime > (model) realtime_tool_choice_config > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice", - "deprecated": false, - "schemaType": "union", + "default": "auto", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_tool_choice_config", "childrenParentSchema": "union", "children": [ @@ -609,19 +611,19 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "Tools available to the model.", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "Tools available to the model.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeToolsConfig", "$ref": "(resource) realtime > (model) realtime_tools_config > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", - "deprecated": false, - "schemaType": "array", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "array", "modelPath": "(resource) realtime > (model) realtime_tools_config", "childrenParentSchema": "union", "children": [ @@ -631,20 +633,20 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing", + "deprecated": false, "key": "tracing", - "optional": true, - "nullable": true, + "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", + "title": "Tracing Configuration", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTracingConfig", "$ref": "(resource) realtime > (model) realtime_tracing_config > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_tracing_config", "childrenParentSchema": "union", "children": [ @@ -654,20 +656,20 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/truncation", + "deprecated": false, "key": "truncation", - "optional": true, - "nullable": false, + "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", + "title": "Realtime Truncation Controls", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTruncation", "$ref": "(resource) realtime > (model) realtime_truncation > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/truncation", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_truncation", "childrenParentSchema": "union", "children": [ @@ -677,22 +679,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of session to create. Always `transcription` for transcription sessions.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of session to create. Always `transcription` for transcription sessions.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "transcription" } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -701,19 +703,19 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for input and output audio.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTranscriptionSessionAudio", "$ref": "(resource) realtime > (model) realtime_transcription_session_audio > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio", "childrenParentSchema": "object", "children": [ @@ -722,26 +724,26 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_transcription_session_create_request > (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", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include", + "deprecated": false, "key": "include", - "optional": true, - "nullable": false, + "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include/items", "types": [ { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include/items" - }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include" + ] + } }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/include", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -757,18 +759,18 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input", + "deprecated": false, "key": "input", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioConfigInput", "$ref": "(resource) realtime > (model) realtime_audio_config_input > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_audio_config_input", "childrenParentSchema": "object", "children": [ @@ -780,18 +782,18 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config > (schema) > (property) output": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output", + "deprecated": false, "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", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_audio_config_output", "childrenParentSchema": "object", "children": [ @@ -803,6 +805,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_config > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio", + "docstring": "Configuration for input and output audio.\n", "ident": "RealtimeAudioConfig", "type": { "kind": "HttpTypeObject", @@ -815,7 +818,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Configuration for input and output audio.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_config > (schema) > (property) input", @@ -844,13 +846,13 @@ Schema name: `RealtimeClientEventSessionUpdate` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/oneOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -869,9 +871,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1", + "docstring": "The Realtime model used for this session.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -949,10 +953,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-12-15" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/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", @@ -992,27 +994,28 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_prompt > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique identifier of the prompt template to use.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique identifier of the prompt template to use.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema) > (property) variables": { "kind": "HttpDeclProperty", - "title": "Prompt Variables", - "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", + "deprecated": false, "key": "variables", - "optional": true, - "nullable": true, + "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "title": "Prompt Variables", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", "ident": "Record", "typeParameters": [ { @@ -1020,6 +1023,7 @@ Schema name: `RealtimeClientEventSessionUpdate` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties", "types": [ { "kind": "HttpTypeString" @@ -1039,14 +1043,12 @@ Schema name: `RealtimeClientEventSessionUpdate` "ident": "ResponseInputFile", "$ref": "(resource) responses > (model) response_input_file > (schema)" } - ], - "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties" + ] } - ], - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables" + ] }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "childrenParentSchema": "union", "children": [ @@ -1058,21 +1060,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_prompt > (schema) > (property) version": { "kind": "HttpDeclProperty", - "docstring": "Optional version of the prompt template.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", + "deprecated": false, "key": "version", - "optional": true, - "nullable": true, + "docstring": "Optional version of the prompt template.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Prompt", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "ident": "ResponsePrompt", "type": { "kind": "HttpTypeObject", @@ -1088,7 +1091,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -1098,20 +1100,20 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", - "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", + "deprecated": false, "key": "effort", - "optional": true, - "nullable": false, - "default": "low", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoningEffort", "$ref": "(resource) realtime > (model) realtime_reasoning_effort > (schema)" }, - "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", - "deprecated": false, - "schemaType": "enum", + "default": "low", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) realtime_reasoning_effort", "childrenParentSchema": "enum", "children": [ @@ -1125,6 +1127,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoning", + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "ident": "RealtimeReasoning", "type": { "kind": "HttpTypeObject", @@ -1134,7 +1137,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" @@ -1184,9 +1186,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tool_choice_config > (schema)": { "kind": "HttpDeclTypeAlias", "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", "ident": "RealtimeToolChoiceConfig", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice", "types": [ { "kind": "HttpTypeReference", @@ -1203,10 +1207,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "ident": "ToolChoiceMcp", "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" } - ], - "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", "children": [ "(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0", @@ -1232,6 +1234,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items/oneOf/1", + "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", "ident": "McpTool", "type": { "kind": "HttpTypeObject", @@ -1274,7 +1277,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -1294,17 +1296,17 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tools_config > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", + "docstring": "Tools available to the model.", "ident": "RealtimeToolsConfig", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools", "elementType": { "kind": "HttpTypeReference", "ident": "RealtimeToolsConfigUnion", "$ref": "(resource) realtime > (model) realtime_tools_config_union > (schema)" + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools" - }, - "docstring": "Tools available to the model.", "childrenParentSchema": "union", "children": [ "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", @@ -1314,18 +1316,18 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/0", + "docstring": "Enables tracing and sets default values for tracing configuration options. Always `auto`.\n", "ident": "Auto", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/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" @@ -1334,6 +1336,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1", + "docstring": "Granular configuration for tracing.\n", "ident": "TracingConfiguration", "type": { "kind": "HttpTypeObject", @@ -1349,7 +1352,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Granular configuration for tracing.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) group_id", @@ -1360,19 +1362,21 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tracing_config > (schema)": { "kind": "HttpDeclTypeAlias", "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", "ident": "RealtimeTracingConfig", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/0" + ] }, { "kind": "HttpTypeObject", @@ -1388,10 +1392,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "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", @@ -1401,9 +1403,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "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.", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -1413,10 +1417,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "disabled" } - ], - "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", "children": [ "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0 > (member) 0", @@ -1426,6 +1428,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1", + "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.", "ident": "RetentionRatioTruncation", "type": { "kind": "HttpTypeObject", @@ -1441,7 +1444,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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 > (schema) > (variant) 1 > (property) retention_ratio", @@ -1452,12 +1454,15 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_truncation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation", + "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", "ident": "RealtimeTruncation", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -1467,8 +1472,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "disabled" } - ], - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0" + ] }, { "kind": "HttpTypeObject", @@ -1484,10 +1488,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "oasRef": "#/components/schemas/RealtimeTruncation" + ] }, - "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", "childrenParentSchema": "union", "children": [ "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0", @@ -1503,18 +1505,18 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input", + "deprecated": false, "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", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input", "childrenParentSchema": "object", "children": [ @@ -1527,6 +1529,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_transcription_session_audio > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio", + "docstring": "Configuration for input and output audio.\n", "ident": "RealtimeTranscriptionSessionAudio", "type": { "kind": "HttpTypeObject", @@ -1536,7 +1539,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Configuration for input and output audio.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input" @@ -1551,19 +1553,19 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the input audio.", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the input audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -1574,10 +1576,10 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config_input > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", + "deprecated": false, "key": "noise_reduction", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeObject", "members": [ @@ -1586,8 +1588,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -1596,44 +1598,46 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config_input > (schema) > (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](/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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", + "deprecated": false, "key": "transcription", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeReference", "ident": "AudioTranscription", "$ref": "(resource) realtime > (model) audio_transcription > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) audio_transcription", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", + "(resource) realtime > (model) audio_transcription > (schema) > (property) keywords", "(resource) realtime > (model) audio_transcription > (schema) > (property) language", + "(resource) realtime > (model) audio_transcription > (schema) > (property) languages", "(resource) realtime > (model) audio_transcription > (schema) > (property) model", "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" ] }, "(resource) realtime > (model) realtime_audio_config_input > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, "key": "turn_detection", - "optional": true, - "nullable": true, + "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", + "title": "Realtime Turn Detection", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioInputTurnDetection", "$ref": "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_input_turn_detection", "childrenParentSchema": "union", "children": [ @@ -1672,19 +1676,19 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the output audio.", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the output audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -1695,39 +1699,40 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config_output > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/speed", + "deprecated": false, "key": "speed", - "optional": true, - "nullable": false, - "default": 1, + "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", "type": { "kind": "HttpTypeNumber" }, "constraints": { - "maximum": 1.5, - "minimum": 0.25 + "minimum": 0.25, + "maximum": 1.5 }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/speed", - "deprecated": false, + "default": 1, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) realtime_audio_config_output > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice", + "deprecated": false, "key": "voice", - "optional": true, - "nullable": false, - "default": "alloy", + "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", + "title": "Voice", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -1769,8 +1774,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, { "kind": "HttpTypeObject", @@ -1780,11 +1784,11 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice", - "deprecated": false, + "default": "alloy", + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -2018,6 +2022,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) responses > (model) response_input_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputTextContent", + "docstring": "A text input to the model.", "ident": "ResponseInputText", "type": { "kind": "HttpTypeObject", @@ -2033,7 +2038,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "A text input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_text > (schema) > (property) text", @@ -2044,6 +2048,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) responses > (model) response_input_image > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputImageContent", + "docstring": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "ident": "ResponseInputImage", "type": { "kind": "HttpTypeObject", @@ -2065,7 +2070,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -2078,6 +2082,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) responses > (model) response_input_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputFileContent", + "docstring": "A file input to the model.", "ident": "ResponseInputFile", "type": { "kind": "HttpTypeObject", @@ -2105,7 +2110,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "A file input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_file > (schema) > (property) type", @@ -2155,9 +2159,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_reasoning_effort > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoningEffort", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "ident": "RealtimeReasoningEffort", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeReasoningEffort", "types": [ { "kind": "HttpTypeLiteral", @@ -2179,10 +2185,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "xhigh" } - ], - "oasRef": "#/components/schemas/RealtimeReasoningEffort" + ] }, - "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 0", @@ -2216,9 +2220,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) responses > (model) tool_choice_options > (schema)": { "kind": "HttpDeclTypeAlias", "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", "ident": "ToolChoiceOptions", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceOptions", "types": [ { "kind": "HttpTypeLiteral", @@ -2232,10 +2238,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "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", @@ -2245,36 +2249,36 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_function > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For function calling, the type is always `function`.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For function calling, the type is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2284,6 +2288,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) responses > (model) tool_choice_function > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceFunction", + "docstring": "Use this option to force the model to call a specific function.\n", "ident": "ToolChoiceFunction", "type": { "kind": "HttpTypeObject", @@ -2296,7 +2301,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -2305,36 +2309,36 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server to use.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server to use.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For MCP tools, the type is always `mcp`.", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For MCP tools, the type is always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2343,21 +2347,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to call on the server.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": true, + "docstring": "The name of the tool to call on the server.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_mcp > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceMCP", + "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", "ident": "ToolChoiceMcp", "type": { "kind": "HttpTypeObject", @@ -2373,7 +2378,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -2383,64 +2387,64 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "Parameters of the function in JSON Schema.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "docstring": "Parameters of the function in JSON Schema.", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool, i.e. `function`.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the tool, i.e. `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2478,36 +2482,36 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "A label for this MCP server, used to identify it in tool calls.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "A label for this MCP server, used to identify it in tool calls.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the MCP tool. Always `mcp`.", + "oasRef": "#/components/schemas/MCPTool/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the MCP tool. Always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/type" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2516,14 +2520,16 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers": { "kind": "HttpDeclProperty", - "docstring": "The tool invocation context(s).", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", + "deprecated": false, "key": "allowed_callers", - "optional": true, - "nullable": true, + "docstring": "The tool invocation context(s).", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items", "types": [ { "kind": "HttpTypeLiteral", @@ -2533,13 +2539,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "programmatic" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers" + ] + } }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -2549,19 +2553,20 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools": { "kind": "HttpDeclProperty", - "docstring": "List of allowed tool names or a filter object.\n", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", + "deprecated": false, "key": "allowed_tools", - "optional": true, - "nullable": true, + "docstring": "List of allowed tool names or a filter object.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", "types": [ { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" + } }, { "kind": "HttpTypeObject", @@ -2574,11 +2579,10 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -2588,26 +2592,27 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPTool/properties/authorization", + "deprecated": false, "key": "authorization", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/authorization", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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](/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", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", + "deprecated": false, "key": "connector_id", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", "types": [ { "kind": "HttpTypeLiteral", @@ -2641,11 +2646,10 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "connector_sharepoint" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/connector_id" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/connector_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2661,26 +2665,27 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) defer_loading": { "kind": "HttpDeclProperty", - "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", + "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", + "deprecated": false, "key": "defer_loading", - "optional": true, - "nullable": false, + "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) headers": { "kind": "HttpDeclProperty", - "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", + "oasRef": "#/components/schemas/MCPTool/properties/headers", + "deprecated": false, "key": "headers", - "optional": true, - "nullable": true, + "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/MCPTool/properties/headers", "ident": "Record", "typeParameters": [ { @@ -2689,23 +2694,22 @@ Schema name: `RealtimeClientEventSessionUpdate` { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/headers" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/headers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval": { "kind": "HttpDeclProperty", - "docstring": "Specify which of the MCP server's tools require approval.", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", + "deprecated": false, "key": "require_approval", - "optional": true, - "nullable": true, - "default": "always", + "docstring": "Specify which of the MCP server's tools require approval.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", "types": [ { "kind": "HttpTypeObject", @@ -2720,6 +2724,7 @@ Schema name: `RealtimeClientEventSessionUpdate` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -2729,14 +2734,13 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "never" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval", - "deprecated": false, + "default": "always", + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -2746,55 +2750,57 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_description": { "kind": "HttpDeclProperty", - "docstring": "Optional description of the MCP server, used to provide more context.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_description", + "deprecated": false, "key": "server_description", - "optional": true, - "nullable": false, + "docstring": "Optional description of the MCP server, used to provide more context.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPTool/properties/server_url", + "deprecated": false, "key": "server_url", - "optional": true, - "nullable": false, + "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", + "deprecated": false, "key": "tunnel_id", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema)": { "kind": "HttpDeclTypeAlias", "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](/docs/guides/tools-remote-mcp).\n", "ident": "RealtimeToolsConfigUnion", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -2842,10 +2848,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "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](/docs/guides/tools-remote-mcp).\n", "childrenParentSchema": "union", "children": [ "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0", @@ -2861,43 +2865,43 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tracing_config > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/group_id", + "deprecated": false, "key": "group_id", - "optional": true, - "nullable": false, + "docstring": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/group_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": true, - "nullable": false, + "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/metadata", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_tracing_config > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/workflow_name", + "deprecated": false, "key": "workflow_name", - "optional": true, - "nullable": false, + "docstring": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/workflow_name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -2917,10 +2921,10 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", + "deprecated": false, "key": "retention_ratio", - "optional": false, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -2928,29 +2932,29 @@ Schema name: `RealtimeClientEventSessionUpdate` "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Use retention ratio truncation.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Use retention ratio truncation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "retention_ratio" } - ], - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2959,10 +2963,10 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", + "deprecated": false, "key": "token_limits", - "optional": true, - "nullable": false, + "docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.", "type": { "kind": "HttpTypeObject", "members": [ @@ -2971,8 +2975,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -2981,19 +2985,19 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -3004,10 +3008,10 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", + "deprecated": false, "key": "noise_reduction", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeObject", "members": [ @@ -3016,8 +3020,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3026,44 +3030,46 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (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](/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", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", + "deprecated": false, "key": "transcription", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeReference", "ident": "AudioTranscription", "$ref": "(resource) realtime > (model) audio_transcription > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/transcription", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) audio_transcription", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", + "(resource) realtime > (model) audio_transcription > (schema) > (property) keywords", "(resource) realtime > (model) audio_transcription > (schema) > (property) language", + "(resource) realtime > (model) audio_transcription > (schema) > (property) languages", "(resource) realtime > (model) audio_transcription > (schema) > (property) model", "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" ] }, "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, "key": "turn_detection", - "optional": true, - "nullable": true, + "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", + "title": "Realtime Turn Detection", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTranscriptionSessionAudioInputTurnDetection", "$ref": "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection", "childrenParentSchema": "union", "children": [ @@ -3103,7 +3109,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "PCMAudioFormat", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "ident": "PCMAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -3115,7 +3122,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate", @@ -3125,7 +3131,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "PCMUAudioFormat", + "docstring": "The G.711 μ-law format.", + "ident": "PCMUAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -3134,7 +3141,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "The G.711 μ-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type" @@ -3143,7 +3149,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "PCMAAudioFormat", + "docstring": "The G.711 A-law format.", + "ident": "PCMAAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -3152,7 +3159,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "The G.711 A-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type" @@ -3161,9 +3167,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_formats > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "ident": "RealtimeAudioFormats", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats", "types": [ { "kind": "HttpTypeObject", @@ -3192,10 +3200,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats" + ] }, - "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "childrenParentSchema": "union", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0", @@ -3205,19 +3211,19 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_config_input > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeReference", "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", - "deprecated": false, - "schemaType": "enum", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) noise_reduction_type", "childrenParentSchema": "enum", "children": [ @@ -3227,12 +3233,13 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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", + "oasRef": "#/components/schemas/AudioTranscription/properties/delay", + "deprecated": false, "key": "delay", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscription/properties/delay", "types": [ { "kind": "HttpTypeLiteral", @@ -3254,11 +3261,10 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "xhigh" } - ], - "oasRef": "#/components/schemas/AudioTranscription/properties/delay" + ] }, - "oasRef": "#/components/schemas/AudioTranscription/properties/delay", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3269,39 +3275,85 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 4" ] }, + "(resource) realtime > (model) audio_transcription > (schema) > (property) keywords": { + "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AudioTranscription/properties/keywords", + "deprecated": false, + "key": "keywords", + "docstring": "Words or phrases to guide transcription of the input audio. Supported by `gpt-transcribe` and `gpt-live-transcribe`.\n", + "type": { + "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/AudioTranscription/properties/keywords", + "elementType": { + "kind": "HttpTypeString" + } + }, + "optional": true, + "nullable": false, + "schemaType": "array", + "children": [] + }, "(resource) realtime > (model) audio_transcription > (schema) > (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", + "oasRef": "#/components/schemas/AudioTranscription/properties/language", + "deprecated": false, "key": "language", + "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", + "type": { + "kind": "HttpTypeString" + }, "optional": true, "nullable": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime > (model) audio_transcription > (schema) > (property) languages": { + "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AudioTranscription/properties/languages", + "deprecated": false, + "key": "languages", + "docstring": "Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. Supported by `gpt-transcribe` and `gpt-live-transcribe`.\n", "type": { + "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/AudioTranscription/properties/languages", + "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/AudioTranscription/properties/language", - "deprecated": false, - "schemaType": "string", + "optional": true, + "nullable": false, + "schemaType": "array", "children": [] }, "(resource) realtime > (model) audio_transcription > (schema) > (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", + "oasRef": "#/components/schemas/AudioTranscription/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscription/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -3322,14 +3374,12 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/AudioTranscription/properties/model" + ] }, - "oasRef": "#/components/schemas/AudioTranscription/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -3339,15 +3389,15 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) audio_transcription > (schema) > (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](/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", + "oasRef": "#/components/schemas/AudioTranscription/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": false, + "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](/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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscription/properties/prompt", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -3361,9 +3411,15 @@ Schema name: `RealtimeClientEventSessionUpdate` { "ident": "delay" }, + { + "ident": "keywords" + }, { "ident": "language" }, + { + "ident": "languages" + }, { "ident": "model" }, @@ -3375,7 +3431,9 @@ Schema name: `RealtimeClientEventSessionUpdate` "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) audio_transcription > (schema) > (property) delay", + "(resource) realtime > (model) audio_transcription > (schema) > (property) keywords", "(resource) realtime > (model) audio_transcription > (schema) > (property) language", + "(resource) realtime > (model) audio_transcription > (schema) > (property) languages", "(resource) realtime > (model) audio_transcription > (schema) > (property) model", "(resource) realtime > (model) audio_transcription > (schema) > (property) prompt" ] @@ -3383,6 +3441,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0", + "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "ident": "ServerVad", "type": { "kind": "HttpTypeObject", @@ -3410,7 +3469,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -3425,6 +3483,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1", + "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "ident": "SemanticVad", "type": { "kind": "HttpTypeObject", @@ -3443,7 +3502,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -3455,9 +3513,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema)": { "kind": "HttpDeclTypeAlias", "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", "ident": "RealtimeAudioInputTurnDetection", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", "types": [ { "kind": "HttpTypeObject", @@ -3502,10 +3562,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "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", @@ -3527,6 +3585,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -3568,8 +3627,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -3588,6 +3646,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1", + "docstring": "Custom voice reference.", "ident": "ID", "type": { "kind": "HttpTypeObject", @@ -3597,7 +3656,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "docstring": "Custom voice reference.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2 > (property) id" @@ -3605,37 +3663,37 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_text > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text input to the model.", + "oasRef": "#/components/schemas/InputTextContent/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text input to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputTextContent/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_text`.", + "oasRef": "#/components/schemas/InputTextContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_text", + "docstring": "The type of the input item. Always `input_text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputTextContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/InputTextContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/type", - "deprecated": false, + "default": "input_text", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3644,11 +3702,11 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -3657,8 +3715,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3667,12 +3725,13 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_image > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": false, - "nullable": false, + "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -3690,11 +3749,10 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "original" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/detail", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3706,23 +3764,23 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_image > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_image`.", + "oasRef": "#/components/schemas/InputImageContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_image", + "docstring": "The type of the input item. Always `input_image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/type", - "deprecated": false, + "default": "input_image", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3731,42 +3789,42 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_image > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputImageContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputImageContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", + "oasRef": "#/components/schemas/InputImageContent/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": true, + "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputImageContent/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -3775,8 +3833,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3785,23 +3843,23 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_file > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_file`.", + "oasRef": "#/components/schemas/InputFileContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_file", + "docstring": "The type of the input item. Always `input_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_file" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/type", - "deprecated": false, + "default": "input_file", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3810,12 +3868,13 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, + "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -3829,11 +3888,10 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/detail", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3844,70 +3902,70 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_file > (schema) > (property) file_data": { "kind": "HttpDeclProperty", - "docstring": "The content of the file to be sent to the model.\n", + "oasRef": "#/components/schemas/InputFileContent/properties/file_data", + "deprecated": false, "key": "file_data", - "optional": true, - "nullable": false, + "docstring": "The content of the file to be sent to the model.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_data", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_url", + "deprecated": false, "key": "file_url", - "optional": true, - "nullable": false, + "docstring": "The URL of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) filename": { "kind": "HttpDeclProperty", - "docstring": "The name of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/filename", + "deprecated": false, "key": "filename", - "optional": true, - "nullable": false, + "docstring": "The name of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/filename", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -3916,8 +3974,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3969,20 +4027,21 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", + "docstring": "A string array of allowed tool names", "ident": "McpAllowedTools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" + } }, - "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": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/1", + "docstring": "A filter object to specify which tools are allowed.\n", "ident": "McpToolFilter", "type": { "kind": "HttpTypeObject", @@ -3995,7 +4054,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -4061,6 +4119,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0", + "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", "ident": "McpToolApprovalFilter", "type": { "kind": "HttpTypeObject", @@ -4073,7 +4132,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -4083,9 +4141,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1": { "kind": "HttpDeclTypeAlias", "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", "ident": "McpToolApprovalSetting", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -4095,10 +4155,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "never" } - ], - "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", @@ -4114,36 +4172,36 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", + "deprecated": false, "key": "post_instructions", - "optional": true, - "nullable": false, + "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.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeReference", "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction/properties/type", - "deprecated": false, - "schemaType": "enum", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) noise_reduction_type", "childrenParentSchema": "enum", "children": [ @@ -4154,6 +4212,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0", + "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "ident": "ServerVad", "type": { "kind": "HttpTypeObject", @@ -4181,7 +4240,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type", @@ -4196,6 +4254,7 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1", + "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "ident": "SemanticVad", "type": { "kind": "HttpTypeObject", @@ -4214,7 +4273,6 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "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", @@ -4226,9 +4284,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema)": { "kind": "HttpDeclTypeAlias", "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", "ident": "RealtimeTranscriptionSessionAudioInputTurnDetection", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection", "types": [ { "kind": "HttpTypeObject", @@ -4273,10 +4333,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] } - ], - "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", "children": [ "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0", @@ -4285,22 +4343,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { "kind": "HttpDeclProperty", - "docstring": "The sample rate of the audio. Always `24000`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", + "deprecated": false, "key": "rate", - "optional": true, - "nullable": false, + "docstring": "The sample rate of the audio. Always `24000`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", "types": [ { "kind": "HttpTypeLiteral", "literal": 24000 } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4309,22 +4367,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcm`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcm`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcm" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4333,22 +4391,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcmu`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcmu`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcmu" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4357,22 +4415,22 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcma`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcma`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcma" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4396,9 +4454,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) noise_reduction_type > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/NoiseReductionType", + "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", "ident": "NoiseReductionType", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/NoiseReductionType", "types": [ { "kind": "HttpTypeLiteral", @@ -4408,10 +4468,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "far_field" } - ], - "oasRef": "#/components/schemas/NoiseReductionType" + ] }, - "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", "childrenParentSchema": "enum", "children": [ "(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0", @@ -4465,14 +4523,24 @@ Schema name: `RealtimeClientEventSessionUpdate` "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1", + "docstring": "The model to use for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `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", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -4493,10 +4561,8 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscription/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", "childrenParentSchema": "enum", "children": [ "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 0", @@ -4504,28 +4570,30 @@ Schema name: `RealtimeClientEventSessionUpdate` "(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 > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5", + "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 6", + "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 7" ] }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "server_vad", + "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "server_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", - "deprecated": false, + "default": "server_vad", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4534,25 +4602,25 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", + "deprecated": false, "key": "idle_timeout_ms", - "optional": true, - "nullable": true, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -4560,86 +4628,86 @@ Schema name: `RealtimeClientEventSessionUpdate` "minimum": 5000, "maximum": 30000 }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", + "deprecated": false, "key": "prefix_padding_ms", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", + "deprecated": false, "key": "silence_duration_ms", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", + "deprecated": false, "key": "threshold", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "semantic_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4648,28 +4716,28 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", + "deprecated": false, "key": "eagerness", - "optional": true, - "nullable": false, - "default": "auto", + "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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", "types": [ { "kind": "HttpTypeLiteral", @@ -4687,11 +4755,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4703,16 +4771,16 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, @@ -4788,18 +4856,18 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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`.", + "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The custom voice ID, e.g. `voice_1234`.", "type": { "kind": "HttpTypeString" }, "examples": [ "voice_1234" ], - "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -4812,23 +4880,23 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4872,23 +4940,23 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4925,23 +4993,23 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4950,44 +5018,44 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", + "deprecated": false, "key": "always", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -4999,8 +5067,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -5010,11 +5078,11 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", + "deprecated": false, "key": "never", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -5026,8 +5094,8 @@ Schema name: `RealtimeClientEventSessionUpdate` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -5051,23 +5119,23 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "server_vad", + "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "server_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", - "deprecated": false, + "default": "server_vad", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5076,25 +5144,25 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": 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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", + "deprecated": false, "key": "idle_timeout_ms", - "optional": true, - "nullable": true, + "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", "type": { "kind": "HttpTypeNumber" }, @@ -5102,86 +5170,86 @@ Schema name: `RealtimeClientEventSessionUpdate` "minimum": 5000, "maximum": 30000 }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", - "deprecated": false, + "optional": true, + "nullable": true, "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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": 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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", + "deprecated": false, "key": "prefix_padding_ms", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", - "deprecated": false, + "optional": true, + "nullable": 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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", + "deprecated": false, "key": "silence_duration_ms", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", - "deprecated": false, + "optional": true, + "nullable": 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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", + "deprecated": false, "key": "threshold", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", - "deprecated": false, + "optional": true, + "nullable": 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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "semantic_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5190,28 +5258,28 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", + "deprecated": false, "key": "eagerness", - "optional": true, - "nullable": false, - "default": "auto", + "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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", "types": [ { "kind": "HttpTypeLiteral", @@ -5229,11 +5297,11 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5245,16 +5313,16 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(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", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, @@ -5297,31 +5365,45 @@ Schema name: `RealtimeClientEventSessionUpdate` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe" + "literal": "gpt-transcribe" } }, "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe-2025-12-15" + "literal": "gpt-live-transcribe" } }, "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe" + "literal": "gpt-4o-mini-transcribe" } }, "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe-diarize" + "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe" + } + }, + "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 6": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe-diarize" + } + }, + "(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -5393,67 +5475,67 @@ Schema name: `RealtimeClientEventSessionUpdate` }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (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", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, @@ -5568,6 +5650,7 @@ Schema name: `RealtimeClientEventInputAudioBufferAppend` "(resource) realtime > (model) input_audio_buffer_append_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend", + "docstring": "Send this event to append audio bytes to the input audio buffer. The audio \nbuffer is temporary storage you can write to and later commit. A \"commit\" will create a new\nuser message item in the conversation history from the buffer content and clear the buffer.\nInput audio transcription (if enabled) will be generated when the buffer is committed.\n\nIf VAD is enabled the audio buffer is used to detect speech and the server will decide \nwhen to commit. When Server VAD is disabled, you must commit the audio buffer\nmanually. Input audio noise reduction operates on writes to the audio buffer.\n\nThe client may choose how much audio to place in each event up to a maximum \nof 15 MiB, for example streaming smaller chunks from the client may allow the \nVAD to be more responsive. Unlike most other client events, the server will \nnot send a confirmation response to this event.\n", "ident": "InputAudioBufferAppendEvent", "type": { "kind": "HttpTypeObject", @@ -5583,7 +5666,6 @@ Schema name: `RealtimeClientEventInputAudioBufferAppend` } ] }, - "docstring": "Send this event to append audio bytes to the input audio buffer. The audio \nbuffer is temporary storage you can write to and later commit. A \"commit\" will create a new\nuser message item in the conversation history from the buffer content and clear the buffer.\nInput audio transcription (if enabled) will be generated when the buffer is committed.\n\nIf VAD is enabled the audio buffer is used to detect speech and the server will decide \nwhen to commit. When Server VAD is disabled, you must commit the audio buffer\nmanually. Input audio noise reduction operates on writes to the audio buffer.\n\nThe client may choose how much audio to place in each event up to a maximum \nof 15 MiB, for example streaming smaller chunks from the client may allow the \nVAD to be more responsive. Unlike most other client events, the server will \nnot send a confirmation response to this event.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) audio", @@ -5593,36 +5675,36 @@ Schema name: `RealtimeClientEventInputAudioBufferAppend` }, "(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes. This must be in the format specified by the \n`input_audio_format` field in the session configuration.\n", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/audio", + "deprecated": false, "key": "audio", - "optional": false, - "nullable": false, + "docstring": "Base64-encoded audio bytes. This must be in the format specified by the \n`input_audio_format` field in the session configuration.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/audio", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.append`.", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.append`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.append" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5631,18 +5713,18 @@ Schema name: `RealtimeClientEventInputAudioBufferAppend` }, "(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -5681,6 +5763,7 @@ Schema name: `RealtimeClientEventInputAudioBufferCommit` "(resource) realtime > (model) input_audio_buffer_commit_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit", + "docstring": "Send this event to commit the user input audio buffer, which will create a new user message item in the conversation. This event will produce an error if the input audio buffer is empty. When in Server VAD mode, the client does not need to send this event, the server will commit the audio buffer automatically.\n\nCommitting the input audio buffer will trigger input audio transcription (if enabled in session configuration), but it will not create a response from the model. The server will respond with an `input_audio_buffer.committed` event.\n", "ident": "InputAudioBufferCommitEvent", "type": { "kind": "HttpTypeObject", @@ -5693,7 +5776,6 @@ Schema name: `RealtimeClientEventInputAudioBufferCommit` } ] }, - "docstring": "Send this event to commit the user input audio buffer, which will create a new user message item in the conversation. This event will produce an error if the input audio buffer is empty. When in Server VAD mode, the client does not need to send this event, the server will commit the audio buffer automatically.\n\nCommitting the input audio buffer will trigger input audio transcription (if enabled in session configuration), but it will not create a response from the model. The server will respond with an `input_audio_buffer.committed` event.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type", @@ -5702,22 +5784,22 @@ Schema name: `RealtimeClientEventInputAudioBufferCommit` }, "(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.commit`.", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.commit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.commit" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5726,18 +5808,18 @@ Schema name: `RealtimeClientEventInputAudioBufferCommit` }, "(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -5774,6 +5856,7 @@ Schema name: `RealtimeClientEventInputAudioBufferClear` "(resource) realtime > (model) input_audio_buffer_clear_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear", + "docstring": "Send this event to clear the audio bytes in the buffer. The server will \nrespond with an `input_audio_buffer.cleared` event.\n", "ident": "InputAudioBufferClearEvent", "type": { "kind": "HttpTypeObject", @@ -5786,7 +5869,6 @@ Schema name: `RealtimeClientEventInputAudioBufferClear` } ] }, - "docstring": "Send this event to clear the audio bytes in the buffer. The server will \nrespond with an `input_audio_buffer.cleared` event.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) type", @@ -5795,22 +5877,22 @@ Schema name: `RealtimeClientEventInputAudioBufferClear` }, "(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.clear`.", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.clear`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.clear" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5819,18 +5901,18 @@ Schema name: `RealtimeClientEventInputAudioBufferClear` }, "(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -5872,6 +5954,7 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) conversation_item_create_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate", + "docstring": "Add a new Item to the Conversation's context, including messages, function \ncalls, and function call responses. This event can be used both to populate a \n\"history\" of the conversation and to add new items mid-stream, but has the \ncurrent limitation that it cannot populate assistant audio messages.\n\nIf successful, the server will respond with a `conversation.item.created` \nevent, otherwise an `error` event will be sent.\n", "ident": "ConversationItemCreateEvent", "type": { "kind": "HttpTypeObject", @@ -5890,7 +5973,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "Add a new Item to the Conversation's context, including messages, function \ncalls, and function call responses. This event can be used both to populate a \n\"history\" of the conversation and to add new items mid-stream, but has the \ncurrent limitation that it cannot populate assistant audio messages.\n\nIf successful, the server will respond with a `conversation.item.created` \nevent, otherwise an `error` event will be sent.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_create_event > (schema) > (property) item", @@ -5901,19 +5983,19 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) conversation_item_create_event > (schema) > (property) item": { "kind": "HttpDeclProperty", - "docstring": "A single item within a Realtime conversation.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/item", + "deprecated": false, "key": "item", - "optional": false, - "nullable": false, + "docstring": "A single item within a Realtime conversation.", "type": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/item", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) conversation_item", "childrenParentSchema": "union", "children": [ @@ -5930,22 +6012,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) conversation_item_create_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.create`.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.create`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.create" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5954,32 +6036,32 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) conversation_item_create_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_create_event > (schema) > (property) previous_item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation.\n\nIf set to `root`, the new item will be added to the beginning of the conversation.\n\nIf set to an existing ID, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.\n", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/previous_item_id", + "deprecated": false, "key": "previous_item_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the preceding item after which the new item will be inserted. If not set, the new item will be appended to the end of the conversation.\n\nIf set to `root`, the new item will be added to the beginning of the conversation.\n\nIf set to an existing ID, it allows an item to be inserted mid-conversation. If the ID cannot be found, an error will be returned and the item will not be added.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/previous_item_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -6138,9 +6220,11 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -6187,10 +6271,8 @@ Schema name: `RealtimeClientEventConversationItemCreate` "ident": "RealtimeMcpApprovalRequest", "$ref": "(resource) realtime > (model) realtime_mcp_approval_request > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItem" + ] }, - "docstring": "A single item within a Realtime conversation.", "childrenParentSchema": "union", "children": [ "(resource) realtime > (model) conversation_item > (schema) > (variant) 0", @@ -6213,12 +6295,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -6229,11 +6312,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -6243,22 +6325,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6267,22 +6349,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6291,36 +6373,36 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6329,12 +6411,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -6348,11 +6431,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6364,6 +6446,7 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -6388,7 +6471,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content", @@ -6401,12 +6483,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -6429,11 +6512,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -6447,22 +6529,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6471,22 +6553,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6495,36 +6577,36 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6533,12 +6615,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -6552,11 +6635,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6568,6 +6650,7 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -6592,7 +6675,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -6605,12 +6687,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -6627,11 +6710,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -6643,22 +6725,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6667,22 +6749,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6691,36 +6773,36 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6729,12 +6811,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -6748,11 +6831,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6764,6 +6846,7 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -6788,7 +6871,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -6801,50 +6883,50 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6853,50 +6935,50 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6905,12 +6987,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -6924,11 +7007,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6940,6 +7022,7 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -6967,7 +7050,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -6981,50 +7063,50 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7033,36 +7115,36 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7071,12 +7153,13 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -7090,11 +7173,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7106,6 +7188,7 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -7130,7 +7213,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A function call output item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id", @@ -7143,64 +7225,64 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7209,21 +7291,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -7245,7 +7328,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -7257,26 +7339,27 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -7293,11 +7376,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -7309,22 +7391,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7333,21 +7415,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -7366,7 +7449,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A Realtime item listing tools available on an MCP server.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label", @@ -7377,78 +7459,78 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7457,26 +7539,27 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -7493,11 +7576,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -7508,21 +7590,22 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -7553,7 +7636,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id", @@ -7568,78 +7650,78 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7649,6 +7731,7 @@ Schema name: `RealtimeClientEventConversationItemCreate` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -7670,7 +7753,6 @@ Schema name: `RealtimeClientEventConversationItemCreate` } ] }, - "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id", @@ -7682,36 +7764,36 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7762,27 +7844,27 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -7796,11 +7878,11 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7811,57 +7893,58 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -7875,11 +7958,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7932,54 +8014,55 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -7989,11 +8072,10 @@ Schema name: `RealtimeClientEventConversationItemCreate` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8122,57 +8204,57 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -8374,47 +8456,47 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8423,34 +8505,34 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8459,47 +8541,47 @@ Schema name: `RealtimeClientEventConversationItemCreate` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8564,6 +8646,7 @@ Schema name: `RealtimeClientEventConversationItemRetrieve` "(resource) realtime > (model) conversation_item_retrieve_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve", + "docstring": "Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD.\nThe server will respond with a `conversation.item.retrieved` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n", "ident": "ConversationItemRetrieveEvent", "type": { "kind": "HttpTypeObject", @@ -8579,7 +8662,6 @@ Schema name: `RealtimeClientEventConversationItemRetrieve` } ] }, - "docstring": "Send this event when you want to retrieve the server's representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD.\nThe server will respond with a `conversation.item.retrieved` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) item_id", @@ -8589,36 +8671,36 @@ Schema name: `RealtimeClientEventConversationItemRetrieve` }, "(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item to retrieve.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item to retrieve.", "type": { "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/item_id", - "deprecated": false, + }, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.retrieve`.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.retrieve`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.retrieve" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8627,18 +8709,18 @@ Schema name: `RealtimeClientEventConversationItemRetrieve` }, "(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -8685,6 +8767,7 @@ Schema name: `RealtimeClientEventConversationItemTruncate` "(resource) realtime > (model) conversation_item_truncate_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate", + "docstring": "Send this event to truncate a previous assistant message’s audio. The server \nwill produce audio faster than realtime, so this event is useful when the user \ninterrupts to truncate audio that has already been sent to the client but not \nyet played. This will synchronize the server's understanding of the audio with \nthe client's playback.\n\nTruncating audio will delete the server-side text transcript to ensure there \nis not text in the context that hasn't been heard by the user.\n\nIf successful, the server will respond with a `conversation.item.truncated` \nevent. \n", "ident": "ConversationItemTruncateEvent", "type": { "kind": "HttpTypeObject", @@ -8706,7 +8789,6 @@ Schema name: `RealtimeClientEventConversationItemTruncate` } ] }, - "docstring": "Send this event to truncate a previous assistant message’s audio. The server \nwill produce audio faster than realtime, so this event is useful when the user \ninterrupts to truncate audio that has already been sent to the client but not \nyet played. This will synchronize the server's understanding of the audio with \nthe client's playback.\n\nTruncating audio will delete the server-side text transcript to ensure there \nis not text in the context that hasn't been heard by the user.\n\nIf successful, the server will respond with a `conversation.item.truncated` \nevent. \n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) audio_end_ms", @@ -8718,64 +8800,64 @@ Schema name: `RealtimeClientEventConversationItemTruncate` }, "(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) audio_end_ms": { "kind": "HttpDeclProperty", - "docstring": "Inclusive duration up to which audio is truncated, in milliseconds. If \nthe audio_end_ms is greater than the actual audio duration, the server \nwill respond with an error.\n", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/audio_end_ms", + "deprecated": false, "key": "audio_end_ms", - "optional": false, - "nullable": false, + "docstring": "Inclusive duration up to which audio is truncated, in milliseconds. If \nthe audio_end_ms is greater than the actual audio duration, the server \nwill respond with an error.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/audio_end_ms", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part to truncate. Set this to `0`.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part to truncate. Set this to `0`.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the assistant message item to truncate. Only assistant message \nitems can be truncated.\n", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the assistant message item to truncate. Only assistant message \nitems can be truncated.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.truncate`.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.truncate`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.truncate" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8784,18 +8866,18 @@ Schema name: `RealtimeClientEventConversationItemTruncate` }, "(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -8837,6 +8919,7 @@ Schema name: `RealtimeClientEventConversationItemDelete` "(resource) realtime > (model) conversation_item_delete_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete", + "docstring": "Send this event when you want to remove any item from the conversation \nhistory. The server will respond with a `conversation.item.deleted` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n", "ident": "ConversationItemDeleteEvent", "type": { "kind": "HttpTypeObject", @@ -8852,7 +8935,6 @@ Schema name: `RealtimeClientEventConversationItemDelete` } ] }, - "docstring": "Send this event when you want to remove any item from the conversation \nhistory. The server will respond with a `conversation.item.deleted` event, \nunless the item does not exist in the conversation history, in which case the \nserver will respond with an error.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) item_id", @@ -8862,36 +8944,36 @@ Schema name: `RealtimeClientEventConversationItemDelete` }, "(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item to delete.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item to delete.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.delete`.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.delete`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.delete" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8900,18 +8982,18 @@ Schema name: `RealtimeClientEventConversationItemDelete` }, "(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -8972,6 +9054,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) response_create_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate", + "docstring": "This event instructs the server to create a Response, which means triggering \nmodel inference. When in Server VAD mode, the server will create Responses \nautomatically.\n\nA Response will include at least one Item, and may have two, in which case \nthe second will be a function call. These Items will be appended to the \nconversation history by default.\n\nThe server will respond with a `response.created` event, events for Items \nand content created, and finally a `response.done` event to indicate the \nResponse is complete.\n\nThe `response.create` event includes inference configuration like \n`instructions` and `tools`. If these are set, they will override the Session's \nconfiguration for this Response only.\n\nResponses can be created out-of-band of the default Conversation, meaning that they can\nhave arbitrary input, and it's possible to disable writing the output to the Conversation.\nOnly one Response can write to the default Conversation at a time, but otherwise multiple\nResponses can be created in parallel. The `metadata` field is a good way to disambiguate\nmultiple simultaneous Responses.\n\nClients can set `conversation` to `none` to create a Response that does not write to the default\nConversation. Arbitrary input can be provided with the `input` field, which is an array accepting\nraw Items and references to existing Items.\n", "ident": "ResponseCreateEvent", "type": { "kind": "HttpTypeObject", @@ -8987,7 +9070,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "This event instructs the server to create a Response, which means triggering \nmodel inference. When in Server VAD mode, the server will create Responses \nautomatically.\n\nA Response will include at least one Item, and may have two, in which case \nthe second will be a function call. These Items will be appended to the \nconversation history by default.\n\nThe server will respond with a `response.created` event, events for Items \nand content created, and finally a `response.done` event to indicate the \nResponse is complete.\n\nThe `response.create` event includes inference configuration like \n`instructions` and `tools`. If these are set, they will override the Session's \nconfiguration for this Response only.\n\nResponses can be created out-of-band of the default Conversation, meaning that they can\nhave arbitrary input, and it's possible to disable writing the output to the Conversation.\nOnly one Response can write to the default Conversation at a time, but otherwise multiple\nResponses can be created in parallel. The `metadata` field is a good way to disambiguate\nmultiple simultaneous Responses.\n\nClients can set `conversation` to `none` to create a Response that does not write to the default\nConversation. Arbitrary input can be provided with the `input` field, which is an array accepting\nraw Items and references to existing Items.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_create_event > (schema) > (property) type", @@ -8997,22 +9079,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) response_create_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.create`.", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.create`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.create" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9021,36 +9103,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) response_create_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_create_event > (schema) > (property) response": { "kind": "HttpDeclProperty", - "docstring": "Create a new Realtime response with these parameters", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/response", + "deprecated": false, "key": "response", - "optional": true, - "nullable": false, + "docstring": "Create a new Realtime response with these parameters", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseCreateParams", "$ref": "(resource) realtime > (model) realtime_response_create_params > (schema)" }, - "oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/response", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_create_params", "childrenParentSchema": "object", "children": [ @@ -9077,19 +9159,19 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for audio input and output.", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for audio input and output.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseCreateAudioOutput", "$ref": "(resource) realtime > (model) realtime_response_create_audio_output > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_create_audio_output", "childrenParentSchema": "object", "children": [ @@ -9098,18 +9180,20 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation": { "kind": "HttpDeclProperty", - "docstring": "Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which\nwill not add items to default conversation.\n", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation", + "deprecated": false, "key": "conversation", - "optional": true, - "nullable": false, + "docstring": "Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which\nwill not add items to default conversation.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -9119,14 +9203,12 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "none" } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation" + ] }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -9136,21 +9218,21 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) input": { "kind": "HttpDeclProperty", - "docstring": "Input items to include in the prompt for the model. Using this field\ncreates a new context for this Response instead of using the default\nconversation. An empty array `[]` will clear the context for this Response.\nNote that this can include references to items that previously appeared in the session\nusing their id.\n", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/input", + "deprecated": false, "key": "input", - "optional": true, - "nullable": false, + "docstring": "Input items to include in the prompt for the model. Using this field\ncreates a new context for this Response instead of using the default\nconversation. An empty array `[]` will clear the context for this Response.\nNote that this can include references to items that previously appeared in the session\nusing their id.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/input", "elementType": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" + } }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/input" - }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/input", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -9167,45 +9249,45 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (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.\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", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": true, - "nullable": false, + "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.\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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/instructions", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens", + "deprecated": false, "key": "max_output_tokens", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens", "types": [ { "kind": "HttpTypeNumber" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens" + ] }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -9215,32 +9297,34 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": true, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) output_modalities": { "kind": "HttpDeclProperty", - "docstring": "The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/output_modalities", + "deprecated": false, "key": "output_modalities", - "optional": true, - "nullable": false, + "docstring": "The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/output_modalities", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/output_modalities/items", "types": [ { "kind": "HttpTypeLiteral", @@ -9250,13 +9334,11 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "audio" } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/output_modalities/items" - }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/output_modalities" + ] + } }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/output_modalities", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -9266,33 +9348,33 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) parallel_tool_calls": { "kind": "HttpDeclProperty", - "docstring": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/parallel_tool_calls", + "deprecated": false, "key": "parallel_tool_calls", - "optional": true, - "nullable": false, + "docstring": "Whether the model may call multiple tools in parallel. Only supported by\nreasoning Realtime models such as `gpt-realtime-2`.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/parallel_tool_calls", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": true, + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "type": { "kind": "HttpTypeReference", "ident": "ResponsePrompt", "$ref": "(resource) responses > (model) response_prompt > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/prompt", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) responses > (model) response_prompt", "childrenParentSchema": "object", "children": [ @@ -9303,20 +9385,20 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) reasoning": { "kind": "HttpDeclProperty", - "title": "Realtime reasoning configuration", - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/reasoning", + "deprecated": false, "key": "reasoning", - "optional": true, - "nullable": false, + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "title": "Realtime reasoning configuration", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoning", "$ref": "(resource) realtime > (model) realtime_reasoning > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/reasoning", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_reasoning", "childrenParentSchema": "object", "children": [ @@ -9325,13 +9407,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tool_choice", "types": [ { "kind": "HttpTypeReference", @@ -9348,11 +9430,11 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "ToolChoiceMcp", "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tool_choice" + ] }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tool_choice", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -9363,14 +9445,16 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "Tools available to the model.", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "Tools available to the model.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -9418,13 +9502,11 @@ Schema name: `RealtimeClientEventResponseCreate` } ] } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools/items" - }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -9435,6 +9517,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_params > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponseCreateParams", + "docstring": "Create a new Realtime response with these parameters", "ident": "RealtimeResponseCreateParams", "type": { "kind": "HttpTypeObject", @@ -9477,7 +9560,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "Create a new Realtime response with these parameters", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) audio", @@ -9496,9 +9578,9 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -9510,8 +9592,8 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9522,6 +9604,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_audio_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio", + "docstring": "Configuration for audio input and output.", "ident": "RealtimeResponseCreateAudioOutput", "type": { "kind": "HttpTypeObject", @@ -9531,7 +9614,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "Configuration for audio input and output.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output" @@ -9549,9 +9631,11 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation/oneOf/1", + "docstring": "Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which\nwill not add items to default conversation.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -9561,10 +9645,8 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "none" } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation/oneOf/1" + ] }, - "docstring": "Controls which conversation the response is added to. Currently supports\n`auto` and `none`, with `auto` as the default value. The `auto` value\nmeans that the contents of the response will be added to the default\nconversation. Set this to `none` to create an out-of-band response which\nwill not add items to default conversation.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 1 > (member) 0", @@ -9726,9 +9808,11 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -9775,10 +9859,8 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "RealtimeMcpApprovalRequest", "$ref": "(resource) realtime > (model) realtime_mcp_approval_request > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItem" + ] }, - "docstring": "A single item within a Realtime conversation.", "childrenParentSchema": "union", "children": [ "(resource) realtime > (model) conversation_item > (schema) > (variant) 0", @@ -9807,13 +9889,13 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens/oneOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -9823,9 +9905,11 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -9834,10 +9918,8 @@ Schema name: `RealtimeClientEventResponseCreate` { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/Metadata" + ] }, - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) output_modalities > (items) > (member) 0": { @@ -9856,27 +9938,28 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_prompt > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique identifier of the prompt template to use.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique identifier of the prompt template to use.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema) > (property) variables": { "kind": "HttpDeclProperty", - "title": "Prompt Variables", - "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", + "deprecated": false, "key": "variables", - "optional": true, - "nullable": true, + "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "title": "Prompt Variables", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", "ident": "Record", "typeParameters": [ { @@ -9884,6 +9967,7 @@ Schema name: `RealtimeClientEventResponseCreate` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties", "types": [ { "kind": "HttpTypeString" @@ -9903,14 +9987,12 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "ResponseInputFile", "$ref": "(resource) responses > (model) response_input_file > (schema)" } - ], - "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties" + ] } - ], - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables" + ] }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "childrenParentSchema": "union", "children": [ @@ -9922,21 +10004,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_prompt > (schema) > (property) version": { "kind": "HttpDeclProperty", - "docstring": "Optional version of the prompt template.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", + "deprecated": false, "key": "version", - "optional": true, - "nullable": true, + "docstring": "Optional version of the prompt template.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Prompt", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "ident": "ResponsePrompt", "type": { "kind": "HttpTypeObject", @@ -9952,7 +10035,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "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", @@ -9962,20 +10044,20 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", - "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", + "deprecated": false, "key": "effort", - "optional": true, - "nullable": false, - "default": "low", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoningEffort", "$ref": "(resource) realtime > (model) realtime_reasoning_effort > (schema)" }, - "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", - "deprecated": false, - "schemaType": "enum", + "default": "low", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) realtime_reasoning_effort", "childrenParentSchema": "enum", "children": [ @@ -9989,6 +10071,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoning", + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "ident": "RealtimeReasoning", "type": { "kind": "HttpTypeObject", @@ -9998,7 +10081,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" @@ -10048,9 +10130,11 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) responses > (model) tool_choice_options > (schema)": { "kind": "HttpDeclTypeAlias", "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", "ident": "ToolChoiceOptions", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceOptions", "types": [ { "kind": "HttpTypeLiteral", @@ -10064,10 +10148,8 @@ Schema name: `RealtimeClientEventResponseCreate` "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", @@ -10078,6 +10160,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) responses > (model) tool_choice_function > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceFunction", + "docstring": "Use this option to force the model to call a specific function.\n", "ident": "ToolChoiceFunction", "type": { "kind": "HttpTypeObject", @@ -10090,7 +10173,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "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", @@ -10100,6 +10182,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) responses > (model) tool_choice_mcp > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceMCP", + "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", "ident": "ToolChoiceMcp", "type": { "kind": "HttpTypeObject", @@ -10115,7 +10198,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "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", @@ -10141,6 +10223,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools/items/oneOf/1", + "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", "ident": "McpTool", "type": { "kind": "HttpTypeObject", @@ -10183,7 +10266,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "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_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label", @@ -10231,19 +10313,19 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the output audio.", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the output audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -10254,20 +10336,21 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (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", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/voice", + "deprecated": false, "key": "voice", - "optional": true, - "nullable": false, - "default": "alloy", + "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", + "title": "Voice", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/voice", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -10309,8 +10392,7 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, { "kind": "HttpTypeObject", @@ -10320,11 +10402,11 @@ Schema name: `RealtimeClientEventResponseCreate` } ] } - ], - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/voice" + ] }, - "oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/voice", - "deprecated": false, + "default": "alloy", + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -10349,12 +10431,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -10365,11 +10448,10 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -10379,22 +10461,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10403,22 +10485,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10427,36 +10509,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10465,12 +10547,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -10484,11 +10567,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10500,6 +10582,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -10524,7 +10607,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content", @@ -10537,12 +10619,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -10565,11 +10648,10 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -10583,22 +10665,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10607,22 +10689,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10631,36 +10713,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10669,12 +10751,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -10688,11 +10771,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10704,6 +10786,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -10728,7 +10811,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -10741,12 +10823,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -10763,11 +10846,10 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -10779,22 +10861,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10803,22 +10885,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10827,36 +10909,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10865,12 +10947,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -10884,11 +10967,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10900,6 +10982,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -10924,7 +11007,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -10937,50 +11019,50 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10989,50 +11071,50 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11041,12 +11123,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -11060,11 +11143,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11076,6 +11158,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -11103,7 +11186,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -11117,50 +11199,50 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11169,36 +11251,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11207,12 +11289,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -11226,11 +11309,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11242,6 +11324,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -11266,7 +11349,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A function call output item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id", @@ -11279,64 +11361,64 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11345,21 +11427,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -11381,7 +11464,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -11393,26 +11475,27 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -11429,11 +11512,10 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -11445,22 +11527,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11469,21 +11551,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -11502,7 +11585,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A Realtime item listing tools available on an MCP server.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label", @@ -11513,78 +11595,78 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11593,26 +11675,27 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -11629,11 +11712,10 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -11644,21 +11726,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -11689,7 +11772,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id", @@ -11704,78 +11786,78 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11785,6 +11867,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -11806,7 +11889,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id", @@ -11883,6 +11965,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) responses > (model) response_input_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputTextContent", + "docstring": "A text input to the model.", "ident": "ResponseInputText", "type": { "kind": "HttpTypeObject", @@ -11898,7 +11981,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A text input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_text > (schema) > (property) text", @@ -11909,6 +11991,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) responses > (model) response_input_image > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputImageContent", + "docstring": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "ident": "ResponseInputImage", "type": { "kind": "HttpTypeObject", @@ -11930,7 +12013,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "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", @@ -11943,6 +12025,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) responses > (model) response_input_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputFileContent", + "docstring": "A file input to the model.", "ident": "ResponseInputFile", "type": { "kind": "HttpTypeObject", @@ -11970,7 +12053,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A file input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_file > (schema) > (property) type", @@ -12020,9 +12102,11 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_reasoning_effort > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoningEffort", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "ident": "RealtimeReasoningEffort", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeReasoningEffort", "types": [ { "kind": "HttpTypeLiteral", @@ -12044,10 +12128,8 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "xhigh" } - ], - "oasRef": "#/components/schemas/RealtimeReasoningEffort" + ] }, - "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 0", @@ -12080,36 +12162,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_function > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For function calling, the type is always `function`.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For function calling, the type is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12118,36 +12200,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server to use.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server to use.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For MCP tools, the type is always `mcp`.", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For MCP tools, the type is always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12156,78 +12238,78 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to call on the server.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": true, + "docstring": "The name of the tool to call on the server.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(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", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "Parameters of the function in JSON Schema.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "docstring": "Parameters of the function in JSON Schema.", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool, i.e. `function`.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the tool, i.e. `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12236,36 +12318,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPTool/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "A label for this MCP server, used to identify it in tool calls.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the MCP tool. Always `mcp`.", + "oasRef": "#/components/schemas/MCPTool/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the MCP tool. Always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/type" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12274,14 +12356,16 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers": { "kind": "HttpDeclProperty", - "docstring": "The tool invocation context(s).", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", + "deprecated": false, "key": "allowed_callers", - "optional": true, - "nullable": true, + "docstring": "The tool invocation context(s).", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items", "types": [ { "kind": "HttpTypeLiteral", @@ -12291,13 +12375,11 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "programmatic" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers" + ] + } }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -12307,19 +12389,20 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools": { "kind": "HttpDeclProperty", - "docstring": "List of allowed tool names or a filter object.\n", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", + "deprecated": false, "key": "allowed_tools", - "optional": true, - "nullable": true, + "docstring": "List of allowed tool names or a filter object.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", "types": [ { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" + } }, { "kind": "HttpTypeObject", @@ -12332,11 +12415,10 @@ Schema name: `RealtimeClientEventResponseCreate` } ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -12346,26 +12428,27 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPTool/properties/authorization", + "deprecated": false, "key": "authorization", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/authorization", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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](/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", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", + "deprecated": false, "key": "connector_id", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", "types": [ { "kind": "HttpTypeLiteral", @@ -12399,11 +12482,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "connector_sharepoint" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/connector_id" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/connector_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12419,26 +12501,27 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading": { "kind": "HttpDeclProperty", - "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", + "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", + "deprecated": false, "key": "defer_loading", - "optional": true, - "nullable": false, + "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPTool/properties/headers", + "deprecated": false, "key": "headers", - "optional": true, - "nullable": true, + "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/MCPTool/properties/headers", "ident": "Record", "typeParameters": [ { @@ -12447,23 +12530,22 @@ Schema name: `RealtimeClientEventResponseCreate` { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/headers" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/headers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval": { "kind": "HttpDeclProperty", - "docstring": "Specify which of the MCP server's tools require approval.", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", + "deprecated": false, "key": "require_approval", - "optional": true, - "nullable": true, - "default": "always", + "docstring": "Specify which of the MCP server's tools require approval.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", "types": [ { "kind": "HttpTypeObject", @@ -12478,6 +12560,7 @@ Schema name: `RealtimeClientEventResponseCreate` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -12487,14 +12570,13 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "never" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval", - "deprecated": false, + "default": "always", + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -12504,53 +12586,54 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description": { "kind": "HttpDeclProperty", - "docstring": "Optional description of the MCP server, used to provide more context.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_description", + "deprecated": false, "key": "server_description", - "optional": true, - "nullable": false, + "docstring": "Optional description of the MCP server, used to provide more context.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPTool/properties/server_url", + "deprecated": false, "key": "server_url", - "optional": true, - "nullable": false, + "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", + "deprecated": false, "key": "tunnel_id", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "PCMAudioFormat", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "ident": "PCMAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -12562,7 +12645,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate", @@ -12572,7 +12654,8 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "PCMUAudioFormat", + "docstring": "The G.711 μ-law format.", + "ident": "PCMUAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -12581,7 +12664,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "The G.711 μ-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type" @@ -12590,7 +12672,8 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "PCMAAudioFormat", + "docstring": "The G.711 A-law format.", + "ident": "PCMAAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -12599,7 +12682,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "The G.711 A-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type" @@ -12608,9 +12690,11 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_audio_formats > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "ident": "RealtimeAudioFormats", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats", "types": [ { "kind": "HttpTypeObject", @@ -12639,10 +12723,8 @@ Schema name: `RealtimeClientEventResponseCreate` } ] } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats" + ] }, - "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "childrenParentSchema": "union", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0", @@ -12665,6 +12747,7 @@ Schema name: `RealtimeClientEventResponseCreate` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -12706,8 +12789,7 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -12726,6 +12808,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1", + "docstring": "Custom voice reference.", "ident": "ID", "type": { "kind": "HttpTypeObject", @@ -12735,7 +12818,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "Custom voice reference.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 2 > (property) id" @@ -12743,36 +12825,36 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12823,27 +12905,27 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -12857,11 +12939,11 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12872,57 +12954,58 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -12936,11 +13019,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12993,54 +13075,55 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -13050,11 +13133,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13183,57 +13265,57 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -13372,37 +13454,37 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_text > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text input to the model.", + "oasRef": "#/components/schemas/InputTextContent/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text input to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputTextContent/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_text`.", + "oasRef": "#/components/schemas/InputTextContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_text", + "docstring": "The type of the input item. Always `input_text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputTextContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/InputTextContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/type", - "deprecated": false, + "default": "input_text", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13411,11 +13493,11 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -13424,8 +13506,8 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -13434,12 +13516,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_image > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": false, - "nullable": false, + "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -13457,11 +13540,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "original" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/detail", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13473,23 +13555,23 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_image > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_image`.", + "oasRef": "#/components/schemas/InputImageContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_image", + "docstring": "The type of the input item. Always `input_image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/type", - "deprecated": false, + "default": "input_image", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13498,42 +13580,42 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_image > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputImageContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputImageContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", + "oasRef": "#/components/schemas/InputImageContent/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": true, + "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputImageContent/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -13542,8 +13624,8 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -13552,23 +13634,23 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_file > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_file`.", + "oasRef": "#/components/schemas/InputFileContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_file", + "docstring": "The type of the input item. Always `input_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_file" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/type", - "deprecated": false, + "default": "input_file", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13577,12 +13659,13 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, + "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -13596,11 +13679,10 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/detail", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13611,70 +13693,70 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_file > (schema) > (property) file_data": { "kind": "HttpDeclProperty", - "docstring": "The content of the file to be sent to the model.\n", + "oasRef": "#/components/schemas/InputFileContent/properties/file_data", + "deprecated": false, "key": "file_data", - "optional": true, - "nullable": false, + "docstring": "The content of the file to be sent to the model.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_data", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_url", + "deprecated": false, "key": "file_url", - "optional": true, - "nullable": false, + "docstring": "The URL of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) filename": { "kind": "HttpDeclProperty", - "docstring": "The name of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/filename", + "deprecated": false, "key": "filename", - "optional": true, - "nullable": false, + "docstring": "The name of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/filename", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -13683,8 +13765,8 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -13736,20 +13818,21 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", + "docstring": "A string array of allowed tool names", "ident": "McpAllowedTools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" - }, - "docstring": "A string array of allowed tool names", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/1", + "docstring": "A filter object to specify which tools are allowed.\n", "ident": "McpToolFilter", "type": { "kind": "HttpTypeObject", @@ -13762,7 +13845,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "docstring": "A filter object to specify which tools are allowed.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only", @@ -13828,6 +13910,7 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0", + "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", "ident": "McpToolApprovalFilter", "type": { "kind": "HttpTypeObject", @@ -13840,7 +13923,6 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "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_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always", @@ -13850,9 +13932,11 @@ Schema name: `RealtimeClientEventResponseCreate` "(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1": { "kind": "HttpDeclTypeAlias", "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", "ident": "McpToolApprovalSetting", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -13862,10 +13946,8 @@ Schema name: `RealtimeClientEventResponseCreate` "kind": "HttpTypeLiteral", "literal": "never" } - ], - "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_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0", @@ -13874,22 +13956,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { "kind": "HttpDeclProperty", - "docstring": "The sample rate of the audio. Always `24000`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", + "deprecated": false, "key": "rate", - "optional": true, - "nullable": false, + "docstring": "The sample rate of the audio. Always `24000`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", "types": [ { "kind": "HttpTypeLiteral", "literal": 24000 } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13898,22 +13980,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcm`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcm`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcm" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13922,22 +14004,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcmu`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcmu`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcmu" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13946,22 +14028,22 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcma`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcma`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcma" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14040,18 +14122,18 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 2 > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The custom voice ID, e.g. `voice_1234`.", + "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The custom voice ID, e.g. `voice_1234`.", "type": { "kind": "HttpTypeString" }, "examples": [ "voice_1234" ], - "oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, @@ -14120,47 +14202,47 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14169,34 +14251,34 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14205,47 +14287,47 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14261,23 +14343,23 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14321,23 +14403,23 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14374,23 +14456,23 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14399,44 +14481,44 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", + "deprecated": false, "key": "always", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -14448,8 +14530,8 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14459,11 +14541,11 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", + "deprecated": false, "key": "never", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -14475,8 +14557,8 @@ Schema name: `RealtimeClientEventResponseCreate` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14570,67 +14652,67 @@ Schema name: `RealtimeClientEventResponseCreate` }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "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", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_response_create_params > (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.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] } @@ -14693,6 +14775,7 @@ Schema name: `RealtimeClientEventResponseCancel` "(resource) realtime > (model) response_cancel_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel", + "docstring": "Send this event to cancel an in-progress response. The server will respond \nwith a `response.done` event with a status of `response.status=cancelled`. If \nthere is no response to cancel, the server will respond with an error. It's safe\nto call `response.cancel` even if no response is in progress, an error will be\nreturned the session will remain unaffected.\n", "ident": "ResponseCancelEvent", "type": { "kind": "HttpTypeObject", @@ -14708,7 +14791,6 @@ Schema name: `RealtimeClientEventResponseCancel` } ] }, - "docstring": "Send this event to cancel an in-progress response. The server will respond \nwith a `response.done` event with a status of `response.status=cancelled`. If \nthere is no response to cancel, the server will respond with an error. It's safe\nto call `response.cancel` even if no response is in progress, an error will be\nreturned the session will remain unaffected.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_cancel_event > (schema) > (property) type", @@ -14718,22 +14800,22 @@ Schema name: `RealtimeClientEventResponseCancel` }, "(resource) realtime > (model) response_cancel_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.cancel`.", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.cancel`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.cancel" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14742,32 +14824,32 @@ Schema name: `RealtimeClientEventResponseCancel` }, "(resource) realtime > (model) response_cancel_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "Optional client-generated ID used to identify this event.", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "Optional client-generated ID used to identify this event.", "type": { "kind": "HttpTypeString" }, "constraints": { "maxLength": 512 }, - "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_cancel_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "A specific response ID to cancel - if not provided, will cancel an \nin-progress response in the default conversation.\n", + "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": true, - "nullable": false, + "docstring": "A specific response ID to cancel - if not provided, will cancel an \nin-progress response in the default conversation.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/response_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -14807,6 +14889,7 @@ Schema name: `RealtimeClientEventOutputAudioBufferClear` "(resource) realtime > (model) output_audio_buffer_clear_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear", + "docstring": "**WebRTC/SIP Only:** Emit to cut off the current audio response. This will trigger the server to\nstop generating audio and emit a `output_audio_buffer.cleared` event. This\nevent should be preceded by a `response.cancel` client event to stop the\ngeneration of the current response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "ident": "OutputAudioBufferClearEvent", "type": { "kind": "HttpTypeObject", @@ -14819,7 +14902,6 @@ Schema name: `RealtimeClientEventOutputAudioBufferClear` } ] }, - "docstring": "**WebRTC/SIP Only:** Emit to cut off the current audio response. This will trigger the server to\nstop generating audio and emit a `output_audio_buffer.cleared` event. This\nevent should be preceded by a `response.cancel` client event to stop the\ngeneration of the current response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) output_audio_buffer_clear_event > (schema) > (property) type", @@ -14828,22 +14910,22 @@ Schema name: `RealtimeClientEventOutputAudioBufferClear` }, "(resource) realtime > (model) output_audio_buffer_clear_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `output_audio_buffer.clear`.", + "oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `output_audio_buffer.clear`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_audio_buffer.clear" } - ], - "oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14852,15 +14934,15 @@ Schema name: `RealtimeClientEventOutputAudioBufferClear` }, "(resource) realtime > (model) output_audio_buffer_clear_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the client event used for error handling.", + "oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the client event used for error handling.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] },