Realtime client events
These are events that the OpenAI Realtime WebSocket server will accept from the client.
session.update
Send this event to update the session’s configuration.
The client may send this event at any time to update any field
except for voice and model. voice can be updated only if there have been no other audio outputs yet.
When the server receives a session.update, it will respond
with a session.updated event showing the full, effective configuration.
Only the fields that are present in the session.update are updated. To clear a field like
instructions, pass an empty string. To clear a field like tools, pass an empty array.
To clear a field like turn_detection, pass null.
Schema
Schema name: RealtimeClientEventSessionUpdate
{
"(resource) realtime > (model) session_update_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate",
"ident": "SessionUpdateEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "session"
},
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) session_update_event > (schema) > (property) type",
"(resource) realtime > (model) session_update_event > (schema) > (property) event_id"
]
},
"(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",
"key": "session",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RealtimeSessionCreateRequest",
"$ref": "(resource) realtime > (model) realtime_session_create_request > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) session_update_event > (schema) > (property) session > (variant) 0",
"(resource) realtime > (model) session_update_event > (schema) > (property) session > (variant) 1"
]
},
"(resource) realtime > (model) session_update_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The event type, must be `session.update`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "session.update"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) session_update_event > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventSessionUpdate/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) session_update_event > (schema) > (property) session > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeSessionCreateRequest",
"$ref": "(resource) realtime > (model) realtime_session_create_request > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation"
]
},
"(resource) realtime > (model) session_update_event > (schema) > (property) session > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeTranscriptionSessionCreateRequest",
"$ref": "(resource) realtime > (model) realtime_transcription_session_create_request > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type",
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio",
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA",
"ident": "RealtimeSessionCreateRequest",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "audio"
},
{
"ident": "include"
},
{
"ident": "instructions"
},
{
"ident": "max_output_tokens"
},
{
"ident": "model"
},
{
"ident": "output_modalities"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "prompt"
},
{
"ident": "reasoning"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
},
{
"ident": "tracing"
},
{
"ident": "truncation"
}
]
},
"docstring": "Realtime session object configuration.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) instructions",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) parallel_tool_calls",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) reasoning",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tool_choice",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tracing",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) truncation"
]
},
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA",
"ident": "RealtimeTranscriptionSessionCreateRequest",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "audio"
},
{
"ident": "include"
}
]
},
"docstring": "Realtime transcription session object configuration.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type",
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio",
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include"
]
},
"(resource) realtime > (model) session_update_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "session.update"
}
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime"
}
],
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) audio": {
"kind": "HttpDeclProperty",
"docstring": "Configuration for input and output audio.\n",
"key": "audio",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeAudioConfig",
"$ref": "(resource) realtime > (model) realtime_audio_config > (schema)"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_config",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config > (schema) > (property) input",
"(resource) realtime > (model) realtime_audio_config > (schema) > (property) output"
]
},
"(resource) realtime > (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",
"key": "include",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "array",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include > (items) > (member) 0"
]
},
"(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",
"key": "instructions",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/instructions",
"deprecated": 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",
"key": "max_output_tokens",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeNumber"
},
{
"kind": "HttpTypeUnion",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 0",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model": {
"kind": "HttpDeclProperty",
"docstring": "The Realtime model used for this session.\n",
"key": "model",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-1.5"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2.1"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2.1-mini"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2025-08-28"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2024-10-01"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2024-12-17"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2025-06-03"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-realtime-preview"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-realtime-preview-2024-12-17"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini-2025-10-06"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini-2025-12-15"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-1.5"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-mini"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-mini-2025-10-06"
},
{
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 0",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1"
]
},
"(resource) realtime > (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",
"key": "output_modalities",
"optional": true,
"nullable": false,
"default": [
"audio"
],
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
},
{
"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,
"schemaType": "array",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 0",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 1"
]
},
"(resource) realtime > (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",
"key": "parallel_tool_calls",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/parallel_tool_calls",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) prompt": {
"kind": "HttpDeclProperty",
"docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n",
"key": "prompt",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "ResponsePrompt",
"$ref": "(resource) responses > (model) response_prompt > (schema)"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/prompt",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) responses > (model) response_prompt",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_prompt > (schema) > (property) id",
"(resource) responses > (model) response_prompt > (schema) > (property) variables",
"(resource) responses > (model) response_prompt > (schema) > (property) version"
]
},
"(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",
"key": "reasoning",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeReasoning",
"$ref": "(resource) realtime > (model) realtime_reasoning > (schema)"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/reasoning",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_reasoning",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort"
]
},
"(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",
"key": "tool_choice",
"optional": true,
"nullable": false,
"default": "auto",
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_tool_choice_config",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) tools": {
"kind": "HttpDeclProperty",
"docstring": "Tools available to the model.",
"key": "tools",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeToolsConfig",
"$ref": "(resource) realtime > (model) realtime_tools_config > (schema)"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools",
"deprecated": false,
"schemaType": "array",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_tools_config",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1"
]
},
"(resource) realtime > (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",
"key": "tracing",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeTracingConfig",
"$ref": "(resource) realtime > (model) realtime_tracing_config > (schema)"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing",
"deprecated": false,
"schemaType": "union",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_tracing_config",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1"
]
},
"(resource) realtime > (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",
"key": "truncation",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeTruncation",
"$ref": "(resource) realtime > (model) realtime_truncation > (schema)"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/truncation",
"deprecated": false,
"schemaType": "union",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_truncation",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1"
]
},
"(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",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "transcription"
}
],
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type"
},
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) audio": {
"kind": "HttpDeclProperty",
"docstring": "Configuration for input and output audio.\n",
"key": "audio",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeTranscriptionSessionAudio",
"$ref": "(resource) realtime > (model) realtime_transcription_session_audio > (schema)"
},
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_transcription_session_audio",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input"
]
},
"(resource) realtime > (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",
"key": "include",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "array",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include > (items) > (member) 0"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime"
}
},
"(resource) realtime > (model) realtime_audio_config > (schema) > (property) input": {
"kind": "HttpDeclProperty",
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_config_input",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format",
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction",
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription",
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection"
]
},
"(resource) realtime > (model) realtime_audio_config > (schema) > (property) output": {
"kind": "HttpDeclProperty",
"key": "output",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeAudioConfigOutput",
"$ref": "(resource) realtime > (model) realtime_audio_config_output > (schema)"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_config_output",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice"
]
},
"(resource) realtime > (model) realtime_audio_config > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio",
"ident": "RealtimeAudioConfig",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
},
{
"ident": "output"
}
]
},
"docstring": "Configuration for input and output audio.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config > (schema) > (property) input",
"(resource) realtime > (model) realtime_audio_config > (schema) > (property) output"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) include > (items) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "item.input_audio_transcription.logprobs"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeNumber"
},
"children": []
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/oneOf/1",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "inf"
}
],
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/max_output_tokens/oneOf/1"
},
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeString"
},
"children": []
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/model/anyOf/1",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-1.5"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2.1"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2.1-mini"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2025-08-28"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2024-10-01"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2024-12-17"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2025-06-03"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-realtime-preview"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-realtime-preview-2024-12-17"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini-2025-10-06"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini-2025-12-15"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-1.5"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-mini"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-mini-2025-10-06"
},
{
"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",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 1",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 2",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 3",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 4",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 5",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 6",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 7",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 8",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 9",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 10",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 11",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 12",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 13",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 14",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 15",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 16",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 17",
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 18"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) output_modalities > (items) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio"
}
},
"(resource) responses > (model) response_prompt > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique identifier of the prompt template to use.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id",
"deprecated": 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",
"key": "variables",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseInputText",
"$ref": "(resource) responses > (model) response_input_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseInputImage",
"$ref": "(resource) responses > (model) response_input_image > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "map",
"childrenParentSchema": "union",
"children": [
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 0",
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 1",
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 2",
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 3"
]
},
"(resource) responses > (model) response_prompt > (schema) > (property) version": {
"kind": "HttpDeclProperty",
"docstring": "Optional version of the prompt template.",
"key": "version",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) response_prompt > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Prompt",
"ident": "ResponsePrompt",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "variables"
},
{
"ident": "version"
}
]
},
"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",
"(resource) responses > (model) response_prompt > (schema) > (property) variables",
"(resource) responses > (model) response_prompt > (schema) > (property) version"
]
},
"(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",
"key": "effort",
"optional": true,
"nullable": false,
"default": "low",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeReasoningEffort",
"$ref": "(resource) realtime > (model) realtime_reasoning_effort > (schema)"
},
"oasRef": "#/components/schemas/RealtimeReasoning/properties/effort",
"deprecated": false,
"schemaType": "enum",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_reasoning_effort",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 0",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 1",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 2",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 3",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 4"
]
},
"(resource) realtime > (model) realtime_reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeReasoning",
"ident": "RealtimeReasoning",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "effort"
}
]
},
"docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort"
]
},
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolChoiceOptions",
"$ref": "(resource) responses > (model) tool_choice_options > (schema)"
},
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_options > (schema) > (member) 0",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 1",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 2"
]
},
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolChoiceFunction",
"$ref": "(resource) responses > (model) tool_choice_function > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_function > (schema) > (property) name",
"(resource) responses > (model) tool_choice_function > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolChoiceMcp",
"$ref": "(resource) responses > (model) tool_choice_mcp > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) name"
]
},
"(resource) realtime > (model) realtime_tool_choice_config > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tool_choice",
"ident": "RealtimeToolChoiceConfig",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "ToolChoiceOptions",
"$ref": "(resource) responses > (model) tool_choice_options > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ToolChoiceFunction",
"$ref": "(resource) responses > (model) tool_choice_function > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_tool_choice_config > (schema) > (variant) 2"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeFunctionTool",
"$ref": "(resource) realtime > (model) realtime_function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) description",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) name",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items/oneOf/1",
"ident": "McpTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "allowed_callers"
},
{
"ident": "allowed_tools"
},
{
"ident": "authorization"
},
{
"ident": "connector_id"
},
{
"ident": "defer_loading"
},
{
"ident": "headers"
},
{
"ident": "require_approval"
},
{
"ident": "server_description"
},
{
"ident": "server_url"
},
{
"ident": "tunnel_id"
}
]
},
"docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_label",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) authorization",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) defer_loading",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) headers",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_description",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_url",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) tunnel_id"
]
},
"(resource) realtime > (model) realtime_tools_config > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools",
"ident": "RealtimeToolsConfig",
"type": {
"kind": "HttpTypeArray",
"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",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/0",
"ident": "Auto",
"type": {
"kind": "HttpTypeUnion",
"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"
]
},
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1",
"ident": "TracingConfiguration",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "group_id"
},
{
"ident": "metadata"
},
{
"ident": "workflow_name"
}
]
},
"docstring": "Granular configuration for tracing.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) group_id",
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) metadata",
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1 > (property) workflow_name"
]
},
"(resource) realtime > (model) realtime_tracing_config > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing",
"ident": "RealtimeTracingConfig",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
}
],
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/0"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "group_id"
},
{
"ident": "metadata"
},
{
"ident": "workflow_name"
}
]
}
],
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing"
},
"docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0 > (member) 1"
]
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1",
"ident": "RetentionRatioTruncation",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "retention_ratio"
},
{
"ident": "type"
},
{
"ident": "token_limits"
}
]
},
"docstring": "Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio",
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type",
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits"
]
},
"(resource) realtime > (model) realtime_truncation > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTruncation",
"ident": "RealtimeTruncation",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "disabled"
}
],
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "retention_ratio"
},
{
"ident": "type"
},
{
"ident": "token_limits"
}
]
}
],
"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",
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "transcription"
}
},
"(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input": {
"kind": "HttpDeclProperty",
"key": "input",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeTranscriptionSessionAudioInput",
"$ref": "(resource) realtime > (model) realtime_transcription_session_audio_input > (schema)"
},
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format",
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction",
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription",
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio",
"ident": "RealtimeTranscriptionSessionAudio",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input"
}
]
},
"docstring": "Configuration for input and output audio.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio > (schema) > (property) input"
]
},
"(resource) realtime > (model) realtime_transcription_session_create_request > (schema) > (property) include > (items) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "item.input_audio_transcription.logprobs"
}
},
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format": {
"kind": "HttpDeclProperty",
"docstring": "The format of the input audio.",
"key": "format",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_formats",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2"
]
},
"(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",
"key": "noise_reduction",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction > (property) type"
]
},
"(resource) realtime > (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",
"key": "transcription",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) audio_transcription",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay",
"(resource) realtime > (model) audio_transcription > (schema) > (property) language",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model",
"(resource) realtime > (model) audio_transcription > (schema) > (property) prompt"
]
},
"(resource) realtime > (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",
"key": "turn_detection",
"optional": true,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_input_turn_detection",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_audio_config_input > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input",
"ident": "RealtimeAudioConfigInput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "format"
},
{
"ident": "noise_reduction"
},
{
"ident": "transcription"
},
{
"ident": "turn_detection"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) format",
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) noise_reduction",
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) transcription",
"(resource) realtime > (model) realtime_audio_config_input > (schema) > (property) turn_detection"
]
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format": {
"kind": "HttpDeclProperty",
"docstring": "The format of the output audio.",
"key": "format",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_formats",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2"
]
},
"(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",
"key": "speed",
"optional": true,
"nullable": false,
"default": 1,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"maximum": 1.5,
"minimum": 0.25
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/speed",
"deprecated": 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",
"key": "voice",
"optional": true,
"nullable": false,
"default": "alloy",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "alloy"
},
{
"kind": "HttpTypeLiteral",
"literal": "ash"
},
{
"kind": "HttpTypeLiteral",
"literal": "ballad"
},
{
"kind": "HttpTypeLiteral",
"literal": "coral"
},
{
"kind": "HttpTypeLiteral",
"literal": "echo"
},
{
"kind": "HttpTypeLiteral",
"literal": "sage"
},
{
"kind": "HttpTypeLiteral",
"literal": "shimmer"
},
{
"kind": "HttpTypeLiteral",
"literal": "verse"
},
{
"kind": "HttpTypeLiteral",
"literal": "marin"
},
{
"kind": "HttpTypeLiteral",
"literal": "cedar"
}
],
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
}
]
}
],
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output/properties/voice",
"deprecated": false,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 0",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2"
]
},
"(resource) realtime > (model) realtime_audio_config_output > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/output",
"ident": "RealtimeAudioConfigOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "format"
},
{
"ident": "speed"
},
{
"ident": "voice"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) format",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) speed",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice"
]
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "inf"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-1.5"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2.1"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2.1-mini"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-2025-08-28"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2024-10-01"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2024-12-17"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 9": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-realtime-preview-2025-06-03"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 10": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-realtime-preview"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 11": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-realtime-preview-2024-12-17"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 12": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 13": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini-2025-10-06"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 14": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-mini-2025-12-15"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 15": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-1.5"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 16": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-mini"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 17": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-mini-2025-10-06"
}
},
"(resource) realtime > (model) realtime_session_create_request > (schema) > (property) model > (variant) 1 > (member) 18": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-audio-mini-2025-12-15"
}
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeString"
},
"children": []
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseInputText",
"$ref": "(resource) responses > (model) response_input_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) text",
"(resource) responses > (model) response_input_text > (schema) > (property) type",
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseInputImage",
"$ref": "(resource) responses > (model) response_input_image > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) detail",
"(resource) responses > (model) response_input_image > (schema) > (property) type",
"(resource) responses > (model) response_input_image > (schema) > (property) file_id",
"(resource) responses > (model) response_input_image > (schema) > (property) image_url",
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseInputFile",
"$ref": "(resource) responses > (model) response_input_file > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) type",
"(resource) responses > (model) response_input_file > (schema) > (property) detail",
"(resource) responses > (model) response_input_file > (schema) > (property) file_data",
"(resource) responses > (model) response_input_file > (schema) > (property) file_id",
"(resource) responses > (model) response_input_file > (schema) > (property) file_url",
"(resource) responses > (model) response_input_file > (schema) > (property) filename",
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_input_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/InputTextContent",
"ident": "ResponseInputText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
},
{
"ident": "prompt_cache_breakpoint"
}
]
},
"docstring": "A text input to the model.",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) text",
"(resource) responses > (model) response_input_text > (schema) > (property) type",
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_input_image > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/InputImageContent",
"ident": "ResponseInputImage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "detail"
},
{
"ident": "type"
},
{
"ident": "file_id"
},
{
"ident": "image_url"
},
{
"ident": "prompt_cache_breakpoint"
}
]
},
"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",
"(resource) responses > (model) response_input_image > (schema) > (property) type",
"(resource) responses > (model) response_input_image > (schema) > (property) file_id",
"(resource) responses > (model) response_input_image > (schema) > (property) image_url",
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_input_file > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/InputFileContent",
"ident": "ResponseInputFile",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "detail"
},
{
"ident": "file_data"
},
{
"ident": "file_id"
},
{
"ident": "file_url"
},
{
"ident": "filename"
},
{
"ident": "prompt_cache_breakpoint"
}
]
},
"docstring": "A file input to the model.",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) type",
"(resource) responses > (model) response_input_file > (schema) > (property) detail",
"(resource) responses > (model) response_input_file > (schema) > (property) file_data",
"(resource) responses > (model) response_input_file > (schema) > (property) file_id",
"(resource) responses > (model) response_input_file > (schema) > (property) file_url",
"(resource) responses > (model) response_input_file > (schema) > (property) filename",
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "minimal"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "medium"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "xhigh"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeReasoningEffort",
"ident": "RealtimeReasoningEffort",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "minimal"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "medium"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
},
{
"kind": "HttpTypeLiteral",
"literal": "xhigh"
}
],
"oasRef": "#/components/schemas/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",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 1",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 2",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 3",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 4"
]
},
"(resource) responses > (model) tool_choice_options > (schema) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) responses > (model) tool_choice_options > (schema) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) responses > (model) tool_choice_options > (schema) > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(resource) responses > (model) tool_choice_options > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ToolChoiceOptions",
"ident": "ToolChoiceOptions",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "required"
}
],
"oasRef": "#/components/schemas/ToolChoiceOptions"
},
"docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_options > (schema) > (member) 0",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 1",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 2"
]
},
"(resource) responses > (model) tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ToolChoiceFunction/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) tool_choice_function > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For function calling, the type is always `function`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/ToolChoiceFunction/properties/type"
},
"oasRef": "#/components/schemas/ToolChoiceFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_function > (schema) > (property) type > (member) 0"
]
},
"(resource) responses > (model) tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ToolChoiceFunction",
"ident": "ToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "type"
}
]
},
"docstring": "Use this option to force the model to call a specific function.\n",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_function > (schema) > (property) name",
"(resource) responses > (model) tool_choice_function > (schema) > (property) type"
]
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": {
"kind": "HttpDeclProperty",
"docstring": "The label of the MCP server to use.\n",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For MCP tools, the type is always `mcp`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
],
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/type"
},
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type > (member) 0"
]
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the tool to call on the server.\n",
"key": "name",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) tool_choice_mcp > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ToolChoiceMCP",
"ident": "ToolChoiceMcp",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "name"
}
]
},
"docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) name"
]
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) description": {
"kind": "HttpDeclProperty",
"docstring": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function.",
"key": "name",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters": {
"kind": "HttpDeclProperty",
"docstring": "Parameters of the function in JSON Schema.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters",
"deprecated": false,
"schemaType": "unknown",
"children": []
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the tool, i.e. `function`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeFunctionTool",
"ident": "RealtimeFunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "description"
},
{
"ident": "name"
},
{
"ident": "parameters"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) description",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) name",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) server_label": {
"kind": "HttpDeclProperty",
"docstring": "A label for this MCP server, used to identify it in tool calls.\n",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/server_label",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
],
"oasRef": "#/components/schemas/MCPTool/properties/type"
},
"oasRef": "#/components/schemas/MCPTool/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers": {
"kind": "HttpDeclProperty",
"docstring": "The tool invocation context(s).",
"key": "allowed_callers",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "direct"
},
{
"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,
"schemaType": "array",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 0",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 1"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools": {
"kind": "HttpDeclProperty",
"docstring": "List of allowed tool names or a filter object.\n",
"key": "allowed_tools",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
}
],
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools"
},
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools",
"deprecated": false,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 0",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1"
]
},
"(resource) realtime > (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",
"key": "authorization",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/authorization",
"deprecated": 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",
"key": "connector_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "connector_dropbox"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_gmail"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_googlecalendar"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_googledrive"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_microsoftteams"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_outlookcalendar"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_outlookemail"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_sharepoint"
}
],
"oasRef": "#/components/schemas/MCPTool/properties/connector_id"
},
"oasRef": "#/components/schemas/MCPTool/properties/connector_id",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 0",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 1",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 2",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 3",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 4",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 5",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 6",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 7"
]
},
"(resource) realtime > (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",
"key": "defer_loading",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPTool/properties/defer_loading",
"deprecated": 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",
"key": "headers",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeString"
}
],
"oasRef": "#/components/schemas/MCPTool/properties/headers"
},
"oasRef": "#/components/schemas/MCPTool/properties/headers",
"deprecated": false,
"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.",
"key": "require_approval",
"optional": true,
"nullable": true,
"default": "always",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "always"
},
{
"ident": "never"
}
]
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "always"
},
{
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1"
]
},
"(resource) realtime > (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",
"key": "server_description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/server_description",
"deprecated": 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",
"key": "server_url",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/MCPTool/properties/server_url",
"deprecated": 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",
"key": "tunnel_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/tunnel_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_tools_config_union > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items",
"ident": "RealtimeToolsConfigUnion",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RealtimeFunctionTool",
"$ref": "(resource) realtime > (model) realtime_function_tool > (schema)"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "allowed_callers"
},
{
"ident": "allowed_tools"
},
{
"ident": "authorization"
},
{
"ident": "connector_id"
},
{
"ident": "defer_loading"
},
{
"ident": "headers"
},
{
"ident": "require_approval"
},
{
"ident": "server_description"
},
{
"ident": "server_url"
},
{
"ident": "tunnel_id"
}
]
}
],
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tools/items"
},
"docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_tracing_config > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(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",
"key": "group_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/group_id",
"deprecated": 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",
"key": "metadata",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/metadata",
"deprecated": 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",
"key": "workflow_name",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/tracing/oneOf/1/properties/workflow_name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "disabled"
}
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio": {
"kind": "HttpDeclProperty",
"docstring": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.\n",
"key": "retention_ratio",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0,
"maximum": 1
},
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Use retention ratio truncation.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "retention_ratio"
}
],
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type"
},
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits": {
"kind": "HttpDeclProperty",
"docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.",
"key": "token_limits",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "post_instructions"
}
]
},
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format": {
"kind": "HttpDeclProperty",
"docstring": "The PCM audio format. Only a 24kHz sample rate is supported.",
"key": "format",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_formats",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2"
]
},
"(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",
"key": "noise_reduction",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/noise_reduction",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction > (property) type"
]
},
"(resource) realtime > (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",
"key": "transcription",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) audio_transcription",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay",
"(resource) realtime > (model) audio_transcription > (schema) > (property) language",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model",
"(resource) realtime > (model) audio_transcription > (schema) > (property) prompt"
]
},
"(resource) realtime > (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",
"key": "turn_detection",
"optional": true,
"nullable": true,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input",
"ident": "RealtimeTranscriptionSessionAudioInput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "format"
},
{
"ident": "noise_reduction"
},
{
"ident": "transcription"
},
{
"ident": "turn_detection"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) format",
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction",
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) transcription",
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) turn_detection"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0",
"ident": "PCMAudioFormat",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "rate"
},
{
"ident": "type"
}
]
},
"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",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1",
"ident": "PCMUAudioFormat",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "The G.711 μ-law format.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2",
"ident": "PCMAAudioFormat",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "The G.711 A-law format.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats",
"ident": "RealtimeAudioFormats",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "rate"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
}
],
"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",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2"
]
},
"(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",
"key": "type",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) noise_reduction_type",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",
"(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"
]
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay": {
"kind": "HttpDeclProperty",
"docstring": "Controls how long the model waits before emitting transcription text.\nHigher values can improve transcription accuracy at the cost of latency.\nOnly supported with `gpt-realtime-whisper` in GA Realtime sessions.\n",
"key": "delay",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "minimal"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "medium"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
},
{
"kind": "HttpTypeLiteral",
"literal": "xhigh"
}
],
"oasRef": "#/components/schemas/AudioTranscription/properties/delay"
},
"oasRef": "#/components/schemas/AudioTranscription/properties/delay",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 0",
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 1",
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 2",
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 3",
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 4"
]
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) language": {
"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",
"key": "language",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AudioTranscription/properties/language",
"deprecated": false,
"schemaType": "string",
"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",
"key": "model",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "whisper-1"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-transcribe"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-transcribe-2025-12-15"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-transcribe"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-transcribe-diarize"
},
{
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 0",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1"
]
},
"(resource) realtime > (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",
"key": "prompt",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/AudioTranscription/properties/prompt",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) audio_transcription > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AudioTranscription",
"ident": "AudioTranscription",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "delay"
},
{
"ident": "language"
},
{
"ident": "model"
},
{
"ident": "prompt"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay",
"(resource) realtime > (model) audio_transcription > (schema) > (property) language",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model",
"(resource) realtime > (model) audio_transcription > (schema) > (property) prompt"
]
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0",
"ident": "ServerVad",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "idle_timeout_ms"
},
{
"ident": "interrupt_response"
},
{
"ident": "prefix_padding_ms"
},
{
"ident": "silence_duration_ms"
},
{
"ident": "threshold"
}
]
},
"docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold"
]
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1",
"ident": "SemanticVad",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "eagerness"
},
{
"ident": "interrupt_response"
}
]
},
"docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response"
]
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection",
"ident": "RealtimeAudioInputTurnDetection",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "idle_timeout_ms"
},
{
"ident": "interrupt_response"
},
{
"ident": "prefix_padding_ms"
},
{
"ident": "silence_duration_ms"
},
{
"ident": "threshold"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "eagerness"
},
{
"ident": "interrupt_response"
}
]
}
],
"oasRef": "#/components/schemas/RealtimeSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection"
},
"docstring": "Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\n\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\n\nSemantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeString"
},
"children": []
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "alloy"
},
{
"kind": "HttpTypeLiteral",
"literal": "ash"
},
{
"kind": "HttpTypeLiteral",
"literal": "ballad"
},
{
"kind": "HttpTypeLiteral",
"literal": "coral"
},
{
"kind": "HttpTypeLiteral",
"literal": "echo"
},
{
"kind": "HttpTypeLiteral",
"literal": "sage"
},
{
"kind": "HttpTypeLiteral",
"literal": "shimmer"
},
{
"kind": "HttpTypeLiteral",
"literal": "verse"
},
{
"kind": "HttpTypeLiteral",
"literal": "marin"
},
{
"kind": "HttpTypeLiteral",
"literal": "cedar"
}
],
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1"
},
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 0",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 1",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 2",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 3",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 4",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 5",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 6",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 7",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 8",
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 9"
]
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1",
"ident": "ID",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
}
]
},
"docstring": "Custom voice reference.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2 > (property) id"
]
},
"(resource) responses > (model) response_input_text > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text input to the model.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputTextContent/properties/text",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"default": "input_text",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
],
"oasRef": "#/components/schemas/InputTextContent/properties/type"
},
"oasRef": "#/components/schemas/InputTextContent/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "prompt_cache_breakpoint",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "mode"
}
]
},
"oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode"
]
},
"(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`.",
"key": "detail",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "original"
}
],
"oasRef": "#/components/schemas/InputImageContent/properties/detail"
},
"oasRef": "#/components/schemas/InputImageContent/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 0",
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 1",
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 2",
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 3"
]
},
"(resource) responses > (model) response_input_image > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the input item. Always `input_image`.",
"key": "type",
"optional": false,
"nullable": false,
"default": "input_image",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_image"
}
],
"oasRef": "#/components/schemas/InputImageContent/properties/type"
},
"oasRef": "#/components/schemas/InputImageContent/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) type > (member) 0"
]
},
"(resource) responses > (model) response_input_image > (schema) > (property) file_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the file to be sent to the model.",
"key": "file_id",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputImageContent/properties/file_id",
"deprecated": false,
"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.",
"key": "image_url",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/InputImageContent/properties/image_url",
"deprecated": false,
"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.",
"key": "prompt_cache_breakpoint",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "mode"
}
]
},
"oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode"
]
},
"(resource) responses > (model) response_input_file > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the input item. Always `input_file`.",
"key": "type",
"optional": false,
"nullable": false,
"default": "input_file",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_file"
}
],
"oasRef": "#/components/schemas/InputFileContent/properties/type"
},
"oasRef": "#/components/schemas/InputFileContent/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) type > (member) 0"
]
},
"(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`.",
"key": "detail",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/InputFileContent/properties/detail"
},
"oasRef": "#/components/schemas/InputFileContent/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 0",
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 1",
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 2"
]
},
"(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",
"key": "file_data",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputFileContent/properties/file_data",
"deprecated": 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.",
"key": "file_id",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputFileContent/properties/file_id",
"deprecated": false,
"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.",
"key": "file_url",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/InputFileContent/properties/file_url",
"deprecated": 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.",
"key": "filename",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputFileContent/properties/filename",
"deprecated": 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.",
"key": "prompt_cache_breakpoint",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "mode"
}
]
},
"oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode"
]
},
"(resource) responses > (model) tool_choice_function > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "direct"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_callers > (items) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "programmatic"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0",
"ident": "McpAllowedTools",
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/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",
"ident": "McpToolFilter",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
},
"docstring": "A filter object to specify which tools are allowed.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_dropbox"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_gmail"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_googlecalendar"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_googledrive"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_microsoftteams"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_outlookcalendar"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_outlookemail"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) connector_id > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_sharepoint"
}
},
"(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",
"ident": "McpToolApprovalFilter",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "always"
},
{
"ident": "never"
}
]
},
"docstring": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never"
]
},
"(resource) realtime > (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",
"ident": "McpToolApprovalSetting",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "always"
},
{
"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",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1"
]
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "retention_ratio"
}
},
"(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions": {
"kind": "HttpDeclProperty",
"docstring": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.",
"key": "post_instructions",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 0
},
"oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input > (schema) > (property) noise_reduction > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n",
"key": "type",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) noise_reduction_type",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0",
"(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0",
"ident": "ServerVad",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "idle_timeout_ms"
},
{
"ident": "interrupt_response"
},
{
"ident": "prefix_padding_ms"
},
{
"ident": "silence_duration_ms"
},
{
"ident": "threshold"
}
]
},
"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",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1",
"ident": "SemanticVad",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "eagerness"
},
{
"ident": "interrupt_response"
}
]
},
"docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateRequestGA/properties/audio/properties/input/properties/turn_detection",
"ident": "RealtimeTranscriptionSessionAudioInputTurnDetection",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "idle_timeout_ms"
},
{
"ident": "interrupt_response"
},
{
"ident": "prefix_padding_ms"
},
{
"ident": "silence_duration_ms"
},
{
"ident": "threshold"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "create_response"
},
{
"ident": "eagerness"
},
{
"ident": "interrupt_response"
}
]
}
],
"oasRef": "#/components/schemas/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",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": {
"kind": "HttpDeclProperty",
"docstring": "The sample rate of the audio. Always `24000`.",
"key": "rate",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": 24000
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The audio format. Always `audio/pcm`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "audio/pcm"
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The audio format. Always `audio/pcmu`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "audio/pcmu"
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The audio format. Always `audio/pcma`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "audio/pcma"
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) noise_reduction_type > (schema) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "near_field"
}
},
"(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "far_field"
}
},
"(resource) realtime > (model) noise_reduction_type > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/NoiseReductionType",
"ident": "NoiseReductionType",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "near_field"
},
{
"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",
"(resource) realtime > (model) noise_reduction_type > (schema) > (member) 1"
]
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "minimal"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "medium"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) delay > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "xhigh"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeString"
},
"children": []
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/AudioTranscription/properties/model/anyOf/1",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "whisper-1"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-transcribe"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-transcribe-2025-12-15"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-transcribe"
},
{
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-transcribe-diarize"
},
{
"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",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 1",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 2",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 3",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 4",
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5"
]
},
"(resource) realtime > (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",
"key": "type",
"optional": false,
"nullable": false,
"default": "server_vad",
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0"
]
},
"(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",
"key": "create_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms": {
"kind": "HttpDeclProperty",
"docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n",
"key": "idle_timeout_ms",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 5000,
"maximum": 30000
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response": {
"kind": "HttpDeclProperty",
"docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n",
"key": "interrupt_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms": {
"kind": "HttpDeclProperty",
"docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n",
"key": "prefix_padding_ms",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms": {
"kind": "HttpDeclProperty",
"docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n",
"key": "silence_duration_ms",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms",
"deprecated": 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",
"key": "threshold",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0"
]
},
"(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",
"key": "create_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness": {
"kind": "HttpDeclProperty",
"docstring": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.\n",
"key": "eagerness",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "medium"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2",
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3"
]
},
"(resource) realtime > (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",
"key": "interrupt_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "alloy"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "ash"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "ballad"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "coral"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "echo"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "sage"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "shimmer"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "verse"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "marin"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 1 > (member) 9": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cedar"
}
},
"(resource) realtime > (model) realtime_audio_config_output > (schema) > (property) voice > (variant) 2 > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The custom voice ID, e.g. `voice_1234`.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"examples": [
"voice_1234"
],
"oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) response_input_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
},
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode": {
"kind": "HttpDeclProperty",
"docstring": "The breakpoint mode. Always `explicit`.",
"key": "mode",
"optional": false,
"nullable": false,
"default": "explicit",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
],
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode"
},
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0"
]
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "original"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_image"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode": {
"kind": "HttpDeclProperty",
"docstring": "The breakpoint mode. Always `explicit`.",
"key": "mode",
"optional": false,
"nullable": false,
"default": "explicit",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
],
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode"
},
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0"
]
},
"(resource) responses > (model) response_input_file > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_file"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode": {
"kind": "HttpDeclProperty",
"docstring": "The breakpoint mode. Always `explicit`.",
"key": "mode",
"optional": false,
"nullable": false,
"default": "explicit",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
],
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode"
},
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only": {
"kind": "HttpDeclProperty",
"docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n",
"key": "read_only",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/read_only",
"deprecated": 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.",
"key": "tool_names",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names",
"deprecated": 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",
"key": "always",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
},
"oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names"
]
},
"(resource) realtime > (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",
"key": "never",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
},
"oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only",
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names"
]
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "always"
}
},
"(resource) realtime > (model) realtime_tools_config_union > (schema) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "never"
}
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n",
"key": "type",
"optional": false,
"nullable": false,
"default": "server_vad",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "server_vad"
}
],
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) create_response": {
"kind": "HttpDeclProperty",
"docstring": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n",
"key": "create_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) idle_timeout_ms": {
"kind": "HttpDeclProperty",
"docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n",
"key": "idle_timeout_ms",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeNumber"
},
"constraints": {
"minimum": 5000,
"maximum": 30000
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) interrupt_response": {
"kind": "HttpDeclProperty",
"docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n",
"key": "interrupt_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) prefix_padding_ms": {
"kind": "HttpDeclProperty",
"docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n",
"key": "prefix_padding_ms",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) silence_duration_ms": {
"kind": "HttpDeclProperty",
"docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n",
"key": "silence_duration_ms",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) threshold": {
"kind": "HttpDeclProperty",
"docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n",
"key": "threshold",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold",
"deprecated": false,
"schemaType": "number",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) create_response": {
"kind": "HttpDeclProperty",
"docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n",
"key": "create_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response",
"deprecated": 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",
"key": "eagerness",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "medium"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2",
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3"
]
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) interrupt_response": {
"kind": "HttpDeclProperty",
"docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n",
"key": "interrupt_response",
"optional": true,
"nullable": false,
"default": true,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response",
"deprecated": false,
"schemaType": "boolean",
"children": []
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": 24000
}
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio/pcm"
}
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio/pcmu"
}
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio/pcma"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "whisper-1"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-mini-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"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-transcribe"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-4o-transcribe-diarize"
}
},
"(resource) realtime > (model) audio_transcription > (schema) > (property) model > (variant) 1 > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "gpt-realtime-whisper"
}
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_vad"
}
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "semantic_vad"
}
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "medium"
}
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) realtime > (model) realtime_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
},
"(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",
"key": "read_only",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/read_only",
"deprecated": 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.",
"key": "tool_names",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names",
"deprecated": 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",
"key": "read_only",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/read_only",
"deprecated": 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.",
"key": "tool_names",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names",
"deprecated": false,
"schemaType": "array",
"children": []
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "server_vad"
}
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "semantic_vad"
}
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "medium"
}
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) realtime > (model) realtime_transcription_session_audio_input_turn_detection > (schema) > (variant) 1 > (property) eagerness > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
}
}
Example
{
"type": "session.update",
"session": {
"type": "realtime",
"instructions": "You are a creative assistant that helps with design tasks.",
"tools": [
{
"type": "function",
"name": "display_color_palette",
"description": "Call this function when a user asks for a color palette.",
"parameters": {
"type": "object",
"properties": {
"theme": {
"type": "string",
"description": "Description of the theme for the color scheme."
},
"colors": {
"type": "array",
"description": "Array of five hex color codes based on the theme.",
"items": {
"type": "string",
"description": "Hex color code"
}
}
},
"required": [
"theme",
"colors"
]
}
}
],
"tool_choice": "auto"
}
}
input_audio_buffer.append
Send this event to append audio bytes to the input audio buffer. The audio buffer is temporary storage you can write to and later commit. A "commit" will create a new user message item in the conversation history from the buffer content and clear the buffer. Input audio transcription (if enabled) will be generated when the buffer is committed.
If VAD is enabled the audio buffer is used to detect speech and the server will decide when to commit. When Server VAD is disabled, you must commit the audio buffer manually. Input audio noise reduction operates on writes to the audio buffer.
The client may choose how much audio to place in each event up to a maximum of 15 MiB, for example streaming smaller chunks from the client may allow the VAD to be more responsive. Unlike most other client events, the server will not send a confirmation response to this event.
Schema
Schema name: RealtimeClientEventInputAudioBufferAppend
{
"(resource) realtime > (model) input_audio_buffer_append_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend",
"ident": "InputAudioBufferAppendEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "audio"
},
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) type",
"(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) event_id"
]
},
"(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",
"key": "audio",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/audio",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.append"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferAppend/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) input_audio_buffer_append_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.append"
}
}
}
Example
{
"event_id": "event_456",
"type": "input_audio_buffer.append",
"audio": "Base64EncodedAudioData"
}
input_audio_buffer.commit
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.
Committing 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.
Schema
Schema name: RealtimeClientEventInputAudioBufferCommit
{
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit",
"ident": "InputAudioBufferCommitEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) event_id"
]
},
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The event type, must be `input_audio_buffer.commit`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.commit"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferCommit/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) input_audio_buffer_commit_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.commit"
}
}
}
Example
{
"event_id": "event_789",
"type": "input_audio_buffer.commit"
}
input_audio_buffer.clear
Send this event to clear the audio bytes in the buffer. The server will
respond with an input_audio_buffer.cleared event.
Schema
Schema name: RealtimeClientEventInputAudioBufferClear
{
"(resource) realtime > (model) input_audio_buffer_clear_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear",
"ident": "InputAudioBufferClearEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) event_id"
]
},
"(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The event type, must be `input_audio_buffer.clear`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.clear"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventInputAudioBufferClear/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) input_audio_buffer_clear_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_audio_buffer.clear"
}
}
}
Example
{
"event_id": "event_012",
"type": "input_audio_buffer.clear"
}
conversation.item.create
Add a new Item to the Conversation's context, including messages, function calls, and function call responses. This event can be used both to populate a "history" of the conversation and to add new items mid-stream, but has the current limitation that it cannot populate assistant audio messages.
If successful, the server will respond with a conversation.item.created
event, otherwise an error event will be sent.
Schema
Schema name: RealtimeClientEventConversationItemCreate
{
"(resource) realtime > (model) conversation_item_create_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate",
"ident": "ConversationItemCreateEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "item"
},
{
"ident": "type"
},
{
"ident": "event_id"
},
{
"ident": "previous_item_id"
}
]
},
"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",
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) type",
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) event_id",
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) previous_item_id"
]
},
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) item": {
"kind": "HttpDeclProperty",
"docstring": "A single item within a Realtime conversation.",
"key": "item",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "ConversationItem",
"$ref": "(resource) realtime > (model) conversation_item > (schema)"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/item",
"deprecated": false,
"schemaType": "union",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) conversation_item",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) conversation_item > (schema) > (variant) 0",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 1",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 2",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 3",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 4",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 5",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 6",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 7",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 8"
]
},
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The event type, must be `conversation.item.create`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "conversation.item.create"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/event_id",
"deprecated": 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",
"key": "previous_item_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemCreate/properties/previous_item_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemSystemMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemUserMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemAssistantMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCall",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCallOutput",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpApprovalResponse",
"$ref": "(resource) realtime > (model) realtime_mcp_approval_response > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpListTools",
"$ref": "(resource) realtime > (model) realtime_mcp_list_tools > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolCall",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpApprovalRequest",
"$ref": "(resource) realtime > (model) realtime_mcp_approval_request > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type"
]
},
"(resource) realtime > (model) conversation_item > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItem",
"ident": "ConversationItem",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemSystemMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemUserMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemAssistantMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCall",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCallOutput",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpApprovalResponse",
"$ref": "(resource) realtime > (model) realtime_mcp_approval_response > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpListTools",
"$ref": "(resource) realtime > (model) realtime_mcp_list_tools > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolCall",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 1",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 2",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 3",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 4",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 5",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 6",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 7",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 8"
]
},
"(resource) realtime > (model) conversation_item_create_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "conversation.item.create"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": {
"kind": "HttpDeclProperty",
"docstring": "The content of the message.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The role of the message sender. Always `system`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "system"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `message`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem",
"ident": "RealtimeConversationItemSystemMessage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content"
},
{
"ident": "role"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"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",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": {
"kind": "HttpDeclProperty",
"docstring": "The content of the message.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "audio"
},
{
"ident": "detail"
},
{
"ident": "image_url"
},
{
"ident": "text"
},
{
"ident": "transcript"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The role of the message sender. Always `user`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "user"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `message`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser",
"ident": "RealtimeConversationItemUserMessage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content"
},
{
"ident": "role"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"docstring": "A user message item in a Realtime conversation.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": {
"kind": "HttpDeclProperty",
"docstring": "The content of the message.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "audio"
},
{
"ident": "text"
},
{
"ident": "transcript"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The role of the message sender. Always `assistant`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `message`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant",
"ident": "RealtimeConversationItemAssistantMessage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content"
},
{
"ident": "role"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"docstring": "An assistant message item in a Realtime conversation.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status"
]
},
"(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}`.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function_call"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id",
"deprecated": 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.",
"key": "call_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall",
"ident": "RealtimeConversationItemFunctionCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "call_id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"docstring": "A function call item in a Realtime conversation.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status"
]
},
"(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.",
"key": "call_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function_call_output"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput",
"ident": "RealtimeConversationItemFunctionCallOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "call_id"
},
{
"ident": "output"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"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",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status"
]
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the approval response.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id",
"deprecated": 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.",
"key": "approval_request_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": {
"kind": "HttpDeclProperty",
"docstring": "Whether the request was approved.",
"key": "approve",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_response"
}
],
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": {
"kind": "HttpDeclProperty",
"docstring": "Optional reason for the decision.",
"key": "reason",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse",
"ident": "RealtimeMcpApprovalResponse",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "approval_request_id"
},
{
"ident": "approve"
},
{
"ident": "type"
},
{
"ident": "reason"
}
]
},
"docstring": "A Realtime item responding to an MCP approval request.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason"
]
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": {
"kind": "HttpDeclProperty",
"docstring": "The label of the MCP server.",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": {
"kind": "HttpDeclProperty",
"docstring": "The tools available on the server.",
"key": "tools",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input_schema"
},
{
"ident": "name"
},
{
"ident": "annotations"
},
{
"ident": "description"
}
]
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description"
]
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `mcp_list_tools`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_list_tools"
}
],
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the list.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPListTools",
"ident": "RealtimeMcpListTools",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "tools"
},
{
"ident": "type"
},
{
"ident": "id"
}
]
},
"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",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id",
"deprecated": 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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name",
"deprecated": 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.",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_call"
}
],
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of an associated approval request, if any.",
"key": "approval_request_id",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": {
"kind": "HttpDeclProperty",
"docstring": "The error from the tool call, if any.",
"key": "error",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpProtocolError",
"$ref": "(resource) realtime > (model) realtime_mcp_protocol_error > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolExecutionError",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcphttpError",
"$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)"
}
],
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error",
"deprecated": false,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 0",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 1",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 2"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": {
"kind": "HttpDeclProperty",
"docstring": "The output from the tool call.",
"key": "output",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPToolCall",
"ident": "RealtimeMcpToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "approval_request_id"
},
{
"ident": "error"
},
{
"ident": "output"
}
]
},
"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",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output"
]
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the approval request.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id",
"deprecated": 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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the tool to run.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name",
"deprecated": 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.",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_request"
}
],
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest",
"ident": "RealtimeMcpApprovalRequest",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "server_label"
},
{
"ident": "type"
}
]
},
"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",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text content.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "system"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(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.",
"key": "audio",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio",
"deprecated": 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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 2"
]
},
"(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.",
"key": "image_url",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url",
"deprecated": 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`).",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text",
"deprecated": 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.",
"key": "transcript",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript",
"deprecated": 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`).",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_text"
},
{
"kind": "HttpTypeLiteral",
"literal": "input_audio"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "user"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(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.",
"key": "audio",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text content.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text",
"deprecated": 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`.",
"key": "transcript",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "output_text"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 1"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function_call"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function_call_output"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_response"
}
},
"(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",
"key": "input_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema",
"deprecated": 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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/name",
"deprecated": 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",
"key": "annotations",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations",
"deprecated": false,
"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",
"key": "description",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/description",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_list_tools"
}
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_call"
}
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpProtocolError",
"$ref": "(resource) realtime > (model) realtime_mcp_protocol_error > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolExecutionError",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcphttpError",
"$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPProtocolError",
"ident": "RealtimeMcpProtocolError",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError",
"ident": "RealtimeMcpToolExecutionError",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPHTTPError",
"ident": "RealtimeMcphttpError",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_request"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_audio"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_image"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "output_text"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "output_audio"
}
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": {
"kind": "HttpDeclProperty",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": {
"kind": "HttpDeclProperty",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "protocol_error"
}
],
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": {
"kind": "HttpDeclProperty",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_execution_error"
}
],
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": {
"kind": "HttpDeclProperty",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": {
"kind": "HttpDeclProperty",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "http_error"
}
],
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "protocol_error"
}
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_execution_error"
}
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "http_error"
}
}
}
Example
{
"type": "conversation.item.create",
"item": {
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "hi"
}
]
}
}
conversation.item.retrieve
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.
The server will respond with a conversation.item.retrieved event,
unless the item does not exist in the conversation history, in which case the
server will respond with an error.
Schema
Schema name: RealtimeClientEventConversationItemRetrieve
{
"(resource) realtime > (model) conversation_item_retrieve_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve",
"ident": "ConversationItemRetrieveEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "item_id"
},
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) type",
"(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) event_id"
]
},
"(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) item_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the item to retrieve.",
"key": "item_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/item_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "conversation.item.retrieve"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemRetrieve/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) conversation_item_retrieve_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "conversation.item.retrieve"
}
}
}
Example
{
"event_id": "event_901",
"type": "conversation.item.retrieve",
"item_id": "item_003"
}
conversation.item.truncate
Send this event to truncate a previous assistant message’s audio. The server will produce audio faster than realtime, so this event is useful when the user interrupts to truncate audio that has already been sent to the client but not yet played. This will synchronize the server's understanding of the audio with the client's playback.
Truncating audio will delete the server-side text transcript to ensure there is not text in the context that hasn't been heard by the user.
If successful, the server will respond with a conversation.item.truncated
event.
Schema
Schema name: RealtimeClientEventConversationItemTruncate
{
"(resource) realtime > (model) conversation_item_truncate_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate",
"ident": "ConversationItemTruncateEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "audio_end_ms"
},
{
"ident": "content_index"
},
{
"ident": "item_id"
},
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) content_index",
"(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) item_id",
"(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) type",
"(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) event_id"
]
},
"(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",
"key": "audio_end_ms",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/audio_end_ms",
"deprecated": 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`.",
"key": "content_index",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/content_index",
"deprecated": 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",
"key": "item_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/item_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "conversation.item.truncate"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemTruncate/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) conversation_item_truncate_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "conversation.item.truncate"
}
}
}
Example
{
"event_id": "event_678",
"type": "conversation.item.truncate",
"item_id": "item_002",
"content_index": 0,
"audio_end_ms": 1500
}
conversation.item.delete
Send this event when you want to remove any item from the conversation
history. The server will respond with a conversation.item.deleted event,
unless the item does not exist in the conversation history, in which case the
server will respond with an error.
Schema
Schema name: RealtimeClientEventConversationItemDelete
{
"(resource) realtime > (model) conversation_item_delete_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete",
"ident": "ConversationItemDeleteEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "item_id"
},
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) type",
"(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) event_id"
]
},
"(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) item_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the item to delete.",
"key": "item_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/item_id",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "conversation.item.delete"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventConversationItemDelete/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) conversation_item_delete_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "conversation.item.delete"
}
}
}
Example
{
"event_id": "event_901",
"type": "conversation.item.delete",
"item_id": "item_003"
}
response.create
This event instructs the server to create a Response, which means triggering model inference. When in Server VAD mode, the server will create Responses automatically.
A Response will include at least one Item, and may have two, in which case the second will be a function call. These Items will be appended to the conversation history by default.
The server will respond with a response.created event, events for Items
and content created, and finally a response.done event to indicate the
Response is complete.
The response.create event includes inference configuration like
instructions and tools. If these are set, they will override the Session's
configuration for this Response only.
Responses can be created out-of-band of the default Conversation, meaning that they can
have arbitrary input, and it's possible to disable writing the output to the Conversation.
Only one Response can write to the default Conversation at a time, but otherwise multiple
Responses can be created in parallel. The metadata field is a good way to disambiguate
multiple simultaneous Responses.
Clients can set conversation to none to create a Response that does not write to the default
Conversation. Arbitrary input can be provided with the input field, which is an array accepting
raw Items and references to existing Items.
Schema
Schema name: RealtimeClientEventResponseCreate
{
"(resource) realtime > (model) response_create_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventResponseCreate",
"ident": "ResponseCreateEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "event_id"
},
{
"ident": "response"
}
]
},
"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",
"(resource) realtime > (model) response_create_event > (schema) > (property) event_id",
"(resource) realtime > (model) response_create_event > (schema) > (property) response"
]
},
"(resource) realtime > (model) response_create_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The event type, must be `response.create`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "response.create"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) response_create_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) response_create_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) response_create_event > (schema) > (property) response": {
"kind": "HttpDeclProperty",
"docstring": "Create a new Realtime response with these parameters",
"key": "response",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeResponseCreateParams",
"$ref": "(resource) realtime > (model) realtime_response_create_params > (schema)"
},
"oasRef": "#/components/schemas/RealtimeClientEventResponseCreate/properties/response",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_response_create_params",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) audio",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) input",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) instructions",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) metadata",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) output_modalities",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) parallel_tool_calls",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) prompt",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) reasoning",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools"
]
},
"(resource) realtime > (model) response_create_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "response.create"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) audio": {
"kind": "HttpDeclProperty",
"docstring": "Configuration for audio input and output.",
"key": "audio",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_response_create_audio_output",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output"
]
},
"(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",
"key": "conversation",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 1"
]
},
"(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",
"key": "input",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"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,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) conversation_item > (schema) > (variant) 0",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 1",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 2",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 3",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 4",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 5",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 6",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 7",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 8"
]
},
"(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",
"key": "instructions",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/instructions",
"deprecated": 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",
"key": "max_output_tokens",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeNumber"
},
{
"kind": "HttpTypeUnion",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens > (variant) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens > (variant) 1"
]
},
"(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",
"key": "metadata",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Metadata",
"$ref": "(resource) $shared > (model) metadata > (schema)"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/metadata",
"deprecated": false,
"schemaType": "map",
"modelImplicit": false,
"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",
"key": "output_modalities",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "text"
},
{
"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,
"schemaType": "array",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) output_modalities > (items) > (member) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) output_modalities > (items) > (member) 1"
]
},
"(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",
"key": "parallel_tool_calls",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/parallel_tool_calls",
"deprecated": 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",
"key": "prompt",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "ResponsePrompt",
"$ref": "(resource) responses > (model) response_prompt > (schema)"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/prompt",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) responses > (model) response_prompt",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_prompt > (schema) > (property) id",
"(resource) responses > (model) response_prompt > (schema) > (property) variables",
"(resource) responses > (model) response_prompt > (schema) > (property) version"
]
},
"(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",
"key": "reasoning",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeReasoning",
"$ref": "(resource) realtime > (model) realtime_reasoning > (schema)"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/reasoning",
"deprecated": false,
"schemaType": "object",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_reasoning",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort"
]
},
"(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",
"key": "tool_choice",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "ToolChoiceOptions",
"$ref": "(resource) responses > (model) tool_choice_options > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ToolChoiceFunction",
"$ref": "(resource) responses > (model) tool_choice_function > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice > (variant) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice > (variant) 1",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice > (variant) 2"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools": {
"kind": "HttpDeclProperty",
"docstring": "Tools available to the model.",
"key": "tools",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RealtimeFunctionTool",
"$ref": "(resource) realtime > (model) realtime_function_tool > (schema)"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "allowed_callers"
},
{
"ident": "allowed_tools"
},
{
"ident": "authorization"
},
{
"ident": "connector_id"
},
{
"ident": "defer_loading"
},
{
"ident": "headers"
},
{
"ident": "require_approval"
},
{
"ident": "server_description"
},
{
"ident": "server_url"
},
{
"ident": "tunnel_id"
}
]
}
],
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools/items"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeResponseCreateParams",
"ident": "RealtimeResponseCreateParams",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "audio"
},
{
"ident": "conversation"
},
{
"ident": "input"
},
{
"ident": "instructions"
},
{
"ident": "max_output_tokens"
},
{
"ident": "metadata"
},
{
"ident": "output_modalities"
},
{
"ident": "parallel_tool_calls"
},
{
"ident": "prompt"
},
{
"ident": "reasoning"
},
{
"ident": "tool_choice"
},
{
"ident": "tools"
}
]
},
"docstring": "Create a new Realtime response with these parameters",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) audio",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) input",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) instructions",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) metadata",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) output_modalities",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) parallel_tool_calls",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) prompt",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) reasoning",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools"
]
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output": {
"kind": "HttpDeclProperty",
"key": "output",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "format"
},
{
"ident": "voice"
}
]
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) format",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice"
]
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio",
"ident": "RealtimeResponseCreateAudioOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "output"
}
]
},
"docstring": "Configuration for audio input and output.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeString"
},
"children": []
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/conversation/oneOf/1",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"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",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 1 > (member) 1"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemSystemMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemUserMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemAssistantMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCall",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCallOutput",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpApprovalResponse",
"$ref": "(resource) realtime > (model) realtime_mcp_approval_response > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpListTools",
"$ref": "(resource) realtime > (model) realtime_mcp_list_tools > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolCall",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_call > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output"
]
},
"(resource) realtime > (model) conversation_item > (schema) > (variant) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpApprovalRequest",
"$ref": "(resource) realtime > (model) realtime_mcp_approval_request > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type"
]
},
"(resource) realtime > (model) conversation_item > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItem",
"ident": "ConversationItem",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemSystemMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemUserMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemAssistantMessage",
"$ref": "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCall",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeConversationItemFunctionCallOutput",
"$ref": "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpApprovalResponse",
"$ref": "(resource) realtime > (model) realtime_mcp_approval_response > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpListTools",
"$ref": "(resource) realtime > (model) realtime_mcp_list_tools > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolCall",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_call > (schema)"
},
{
"kind": "HttpTypeReference",
"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",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 1",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 2",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 3",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 4",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 5",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 6",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 7",
"(resource) realtime > (model) conversation_item > (schema) > (variant) 8"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeNumber"
},
"children": []
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens/oneOf/1",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "inf"
}
],
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/max_output_tokens/oneOf/1"
},
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0"
]
},
"(resource) $shared > (model) metadata > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Metadata",
"ident": "Metadata",
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"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": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "text"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) output_modalities > (items) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio"
}
},
"(resource) responses > (model) response_prompt > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique identifier of the prompt template to use.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id",
"deprecated": 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",
"key": "variables",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseInputText",
"$ref": "(resource) responses > (model) response_input_text > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "ResponseInputImage",
"$ref": "(resource) responses > (model) response_input_image > (schema)"
},
{
"kind": "HttpTypeReference",
"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,
"schemaType": "map",
"childrenParentSchema": "union",
"children": [
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 0",
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 1",
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 2",
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 3"
]
},
"(resource) responses > (model) response_prompt > (schema) > (property) version": {
"kind": "HttpDeclProperty",
"docstring": "Optional version of the prompt template.",
"key": "version",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) response_prompt > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/Prompt",
"ident": "ResponsePrompt",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "variables"
},
{
"ident": "version"
}
]
},
"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",
"(resource) responses > (model) response_prompt > (schema) > (property) variables",
"(resource) responses > (model) response_prompt > (schema) > (property) version"
]
},
"(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",
"key": "effort",
"optional": true,
"nullable": false,
"default": "low",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeReasoningEffort",
"$ref": "(resource) realtime > (model) realtime_reasoning_effort > (schema)"
},
"oasRef": "#/components/schemas/RealtimeReasoning/properties/effort",
"deprecated": false,
"schemaType": "enum",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_reasoning_effort",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 0",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 1",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 2",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 3",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 4"
]
},
"(resource) realtime > (model) realtime_reasoning > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeReasoning",
"ident": "RealtimeReasoning",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "effort"
}
]
},
"docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolChoiceOptions",
"$ref": "(resource) responses > (model) tool_choice_options > (schema)"
},
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_options > (schema) > (member) 0",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 1",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 2"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolChoiceFunction",
"$ref": "(resource) responses > (model) tool_choice_function > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_function > (schema) > (property) name",
"(resource) responses > (model) tool_choice_function > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tool_choice > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ToolChoiceMcp",
"$ref": "(resource) responses > (model) tool_choice_mcp > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) name"
]
},
"(resource) responses > (model) tool_choice_options > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ToolChoiceOptions",
"ident": "ToolChoiceOptions",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "none"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "required"
}
],
"oasRef": "#/components/schemas/ToolChoiceOptions"
},
"docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_options > (schema) > (member) 0",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 1",
"(resource) responses > (model) tool_choice_options > (schema) > (member) 2"
]
},
"(resource) responses > (model) tool_choice_function > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ToolChoiceFunction",
"ident": "ToolChoiceFunction",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "name"
},
{
"ident": "type"
}
]
},
"docstring": "Use this option to force the model to call a specific function.\n",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_function > (schema) > (property) name",
"(resource) responses > (model) tool_choice_function > (schema) > (property) type"
]
},
"(resource) responses > (model) tool_choice_mcp > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ToolChoiceMCP",
"ident": "ToolChoiceMcp",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "name"
}
]
},
"docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type",
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) name"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeFunctionTool",
"$ref": "(resource) realtime > (model) realtime_function_tool > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) description",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) name",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/tools/items/oneOf/1",
"ident": "McpTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "allowed_callers"
},
{
"ident": "allowed_tools"
},
{
"ident": "authorization"
},
{
"ident": "connector_id"
},
{
"ident": "defer_loading"
},
{
"ident": "headers"
},
{
"ident": "require_approval"
},
{
"ident": "server_description"
},
{
"ident": "server_url"
},
{
"ident": "tunnel_id"
}
]
},
"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",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) type",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) authorization",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) headers",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) server_url",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) tunnel_id"
]
},
"(resource) realtime > (model) realtime_function_tool > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeFunctionTool",
"ident": "RealtimeFunctionTool",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "description"
},
{
"ident": "name"
},
{
"ident": "parameters"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) description",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) name",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters",
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) format": {
"kind": "HttpDeclProperty",
"docstring": "The format of the output audio.",
"key": "format",
"optional": true,
"nullable": false,
"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",
"modelImplicit": false,
"modelPath": "(resource) realtime > (model) realtime_audio_formats",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2"
]
},
"(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",
"key": "voice",
"optional": true,
"nullable": false,
"default": "alloy",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "alloy"
},
{
"kind": "HttpTypeLiteral",
"literal": "ash"
},
{
"kind": "HttpTypeLiteral",
"literal": "ballad"
},
{
"kind": "HttpTypeLiteral",
"literal": "coral"
},
{
"kind": "HttpTypeLiteral",
"literal": "echo"
},
{
"kind": "HttpTypeLiteral",
"literal": "sage"
},
{
"kind": "HttpTypeLiteral",
"literal": "shimmer"
},
{
"kind": "HttpTypeLiteral",
"literal": "verse"
},
{
"kind": "HttpTypeLiteral",
"literal": "marin"
},
{
"kind": "HttpTypeLiteral",
"literal": "cedar"
}
],
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
}
]
}
],
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/voice"
},
"oasRef": "#/components/schemas/RealtimeResponseCreateParams/properties/audio/properties/output/properties/voice",
"deprecated": false,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 0",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 2"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) conversation > (variant) 1 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": {
"kind": "HttpDeclProperty",
"docstring": "The content of the message.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The role of the message sender. Always `system`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "system"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `message`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem",
"ident": "RealtimeConversationItemSystemMessage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content"
},
{
"ident": "role"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"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",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": {
"kind": "HttpDeclProperty",
"docstring": "The content of the message.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "audio"
},
{
"ident": "detail"
},
{
"ident": "image_url"
},
{
"ident": "text"
},
{
"ident": "transcript"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The role of the message sender. Always `user`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "user"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `message`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser",
"ident": "RealtimeConversationItemUserMessage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content"
},
{
"ident": "role"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"docstring": "A user message item in a Realtime conversation.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": {
"kind": "HttpDeclProperty",
"docstring": "The content of the message.",
"key": "content",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "audio"
},
{
"ident": "text"
},
{
"ident": "transcript"
},
{
"ident": "type"
}
]
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": {
"kind": "HttpDeclProperty",
"docstring": "The role of the message sender. Always `assistant`.",
"key": "role",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `message`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "message"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant",
"ident": "RealtimeConversationItemAssistantMessage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "content"
},
{
"ident": "role"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"docstring": "An assistant message item in a Realtime conversation.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status"
]
},
"(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}`.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function_call"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id",
"deprecated": 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.",
"key": "call_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall",
"ident": "RealtimeConversationItemFunctionCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "call_id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"docstring": "A function call item in a Realtime conversation.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status"
]
},
"(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.",
"key": "call_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id",
"deprecated": 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.",
"key": "output",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function_call_output"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id",
"deprecated": 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.",
"key": "object",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object > (member) 0"
]
},
"(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.",
"key": "status",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "completed"
},
{
"kind": "HttpTypeLiteral",
"literal": "incomplete"
},
{
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status"
},
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput",
"ident": "RealtimeConversationItemFunctionCallOutput",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "call_id"
},
{
"ident": "output"
},
{
"ident": "type"
},
{
"ident": "id"
},
{
"ident": "object"
},
{
"ident": "status"
}
]
},
"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",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object",
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status"
]
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the approval response.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id",
"deprecated": 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.",
"key": "approval_request_id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": {
"kind": "HttpDeclProperty",
"docstring": "Whether the request was approved.",
"key": "approve",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_response"
}
],
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": {
"kind": "HttpDeclProperty",
"docstring": "Optional reason for the decision.",
"key": "reason",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPApprovalResponse",
"ident": "RealtimeMcpApprovalResponse",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "approval_request_id"
},
{
"ident": "approve"
},
{
"ident": "type"
},
{
"ident": "reason"
}
]
},
"docstring": "A Realtime item responding to an MCP approval request.\n",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason"
]
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": {
"kind": "HttpDeclProperty",
"docstring": "The label of the MCP server.",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": {
"kind": "HttpDeclProperty",
"docstring": "The tools available on the server.",
"key": "tools",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "input_schema"
},
{
"ident": "name"
},
{
"ident": "annotations"
},
{
"ident": "description"
}
]
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools",
"deprecated": false,
"schemaType": "array",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description"
]
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the item. Always `mcp_list_tools`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_list_tools"
}
],
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the list.",
"key": "id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPListTools",
"ident": "RealtimeMcpListTools",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "server_label"
},
{
"ident": "tools"
},
{
"ident": "type"
},
{
"ident": "id"
}
]
},
"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",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the tool call.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id",
"deprecated": 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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments",
"deprecated": 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.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name",
"deprecated": 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.",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_call"
}
],
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of an associated approval request, if any.",
"key": "approval_request_id",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": {
"kind": "HttpDeclProperty",
"docstring": "The error from the tool call, if any.",
"key": "error",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpProtocolError",
"$ref": "(resource) realtime > (model) realtime_mcp_protocol_error > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolExecutionError",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema)"
},
{
"kind": "HttpTypeReference",
"ident": "RealtimeMcphttpError",
"$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)"
}
],
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error",
"deprecated": false,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 0",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 1",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 2"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": {
"kind": "HttpDeclProperty",
"docstring": "The output from the tool call.",
"key": "output",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPToolCall",
"ident": "RealtimeMcpToolCall",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "server_label"
},
{
"ident": "type"
},
{
"ident": "approval_request_id"
},
{
"ident": "error"
},
{
"ident": "output"
}
]
},
"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",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error",
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output"
]
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": {
"kind": "HttpDeclProperty",
"docstring": "The unique ID of the approval request.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id",
"deprecated": 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.",
"key": "arguments",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the tool to run.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name",
"deprecated": 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.",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_request"
}
],
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPApprovalRequest",
"ident": "RealtimeMcpApprovalRequest",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
},
{
"ident": "arguments"
},
{
"ident": "name"
},
{
"ident": "server_label"
},
{
"ident": "type"
}
]
},
"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",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label",
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) max_output_tokens > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "inf"
}
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties/oneOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeString"
},
"children": []
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseInputText",
"$ref": "(resource) responses > (model) response_input_text > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) text",
"(resource) responses > (model) response_input_text > (schema) > (property) type",
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseInputImage",
"$ref": "(resource) responses > (model) response_input_image > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) detail",
"(resource) responses > (model) response_input_image > (schema) > (property) type",
"(resource) responses > (model) response_input_image > (schema) > (property) file_id",
"(resource) responses > (model) response_input_image > (schema) > (property) image_url",
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_prompt > (schema) > (property) variables > (items) > (variant) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "ResponseInputFile",
"$ref": "(resource) responses > (model) response_input_file > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) type",
"(resource) responses > (model) response_input_file > (schema) > (property) detail",
"(resource) responses > (model) response_input_file > (schema) > (property) file_data",
"(resource) responses > (model) response_input_file > (schema) > (property) file_id",
"(resource) responses > (model) response_input_file > (schema) > (property) file_url",
"(resource) responses > (model) response_input_file > (schema) > (property) filename",
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_input_text > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/InputTextContent",
"ident": "ResponseInputText",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "text"
},
{
"ident": "type"
},
{
"ident": "prompt_cache_breakpoint"
}
]
},
"docstring": "A text input to the model.",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) text",
"(resource) responses > (model) response_input_text > (schema) > (property) type",
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_input_image > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/InputImageContent",
"ident": "ResponseInputImage",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "detail"
},
{
"ident": "type"
},
{
"ident": "file_id"
},
{
"ident": "image_url"
},
{
"ident": "prompt_cache_breakpoint"
}
]
},
"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",
"(resource) responses > (model) response_input_image > (schema) > (property) type",
"(resource) responses > (model) response_input_image > (schema) > (property) file_id",
"(resource) responses > (model) response_input_image > (schema) > (property) image_url",
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) responses > (model) response_input_file > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/InputFileContent",
"ident": "ResponseInputFile",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "detail"
},
{
"ident": "file_data"
},
{
"ident": "file_id"
},
{
"ident": "file_url"
},
{
"ident": "filename"
},
{
"ident": "prompt_cache_breakpoint"
}
]
},
"docstring": "A file input to the model.",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) type",
"(resource) responses > (model) response_input_file > (schema) > (property) detail",
"(resource) responses > (model) response_input_file > (schema) > (property) file_data",
"(resource) responses > (model) response_input_file > (schema) > (property) file_id",
"(resource) responses > (model) response_input_file > (schema) > (property) file_url",
"(resource) responses > (model) response_input_file > (schema) > (property) filename",
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint"
]
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "minimal"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "medium"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "xhigh"
}
},
"(resource) realtime > (model) realtime_reasoning_effort > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeReasoningEffort",
"ident": "RealtimeReasoningEffort",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "minimal"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "medium"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
},
{
"kind": "HttpTypeLiteral",
"literal": "xhigh"
}
],
"oasRef": "#/components/schemas/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",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 1",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 2",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 3",
"(resource) realtime > (model) realtime_reasoning_effort > (schema) > (member) 4"
]
},
"(resource) responses > (model) tool_choice_options > (schema) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "none"
}
},
"(resource) responses > (model) tool_choice_options > (schema) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) responses > (model) tool_choice_options > (schema) > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "required"
}
},
"(resource) responses > (model) tool_choice_function > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function to call.",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ToolChoiceFunction/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) tool_choice_function > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For function calling, the type is always `function`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/ToolChoiceFunction/properties/type"
},
"oasRef": "#/components/schemas/ToolChoiceFunction/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_function > (schema) > (property) type > (member) 0"
]
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": {
"kind": "HttpDeclProperty",
"docstring": "The label of the MCP server to use.\n",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "For MCP tools, the type is always `mcp`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
],
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/type"
},
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type > (member) 0"
]
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the tool to call on the server.\n",
"key": "name",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/ToolChoiceMCP/properties/name",
"deprecated": false,
"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",
"key": "description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) name": {
"kind": "HttpDeclProperty",
"docstring": "The name of the function.",
"key": "name",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters": {
"kind": "HttpDeclProperty",
"docstring": "Parameters of the function in JSON Schema.",
"key": "parameters",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters",
"deprecated": false,
"schemaType": "unknown",
"children": []
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the tool, i.e. `function`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "function"
}
],
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type"
},
"oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type > (member) 0"
]
},
"(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",
"key": "server_label",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/server_label",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
],
"oasRef": "#/components/schemas/MCPTool/properties/type"
},
"oasRef": "#/components/schemas/MCPTool/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers": {
"kind": "HttpDeclProperty",
"docstring": "The tool invocation context(s).",
"key": "allowed_callers",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "direct"
},
{
"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,
"schemaType": "array",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 1"
]
},
"(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",
"key": "allowed_tools",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0"
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
}
],
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools"
},
"oasRef": "#/components/schemas/MCPTool/properties/allowed_tools",
"deprecated": false,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1"
]
},
"(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",
"key": "authorization",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/authorization",
"deprecated": 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",
"key": "connector_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "connector_dropbox"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_gmail"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_googlecalendar"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_googledrive"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_microsoftteams"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_outlookcalendar"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_outlookemail"
},
{
"kind": "HttpTypeLiteral",
"literal": "connector_sharepoint"
}
],
"oasRef": "#/components/schemas/MCPTool/properties/connector_id"
},
"oasRef": "#/components/schemas/MCPTool/properties/connector_id",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 1",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 2",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 3",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 4",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 5",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 6",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 7"
]
},
"(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",
"key": "defer_loading",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPTool/properties/defer_loading",
"deprecated": 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",
"key": "headers",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeReference",
"ident": "Record",
"typeParameters": [
{
"kind": "HttpTypeString"
},
{
"kind": "HttpTypeString"
}
],
"oasRef": "#/components/schemas/MCPTool/properties/headers"
},
"oasRef": "#/components/schemas/MCPTool/properties/headers",
"deprecated": false,
"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.",
"key": "require_approval",
"optional": true,
"nullable": true,
"default": "always",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "always"
},
{
"ident": "never"
}
]
},
{
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "always"
},
{
"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,
"schemaType": "union",
"childrenParentSchema": "union",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1"
]
},
"(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",
"key": "server_description",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/server_description",
"deprecated": 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",
"key": "server_url",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/MCPTool/properties/server_url",
"deprecated": 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",
"key": "tunnel_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPTool/properties/tunnel_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0",
"ident": "PCMAudioFormat",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "rate"
},
{
"ident": "type"
}
]
},
"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",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1",
"ident": "PCMUAudioFormat",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "The G.711 μ-law format.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2",
"ident": "PCMAAudioFormat",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
"docstring": "The G.711 A-law format.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeAudioFormats",
"ident": "RealtimeAudioFormats",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "rate"
},
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
},
{
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
}
]
}
],
"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",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1",
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2"
]
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 0": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/0",
"ident": "UnionMember0",
"type": {
"kind": "HttpTypeString"
},
"children": []
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1",
"ident": "UnionMember1",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "alloy"
},
{
"kind": "HttpTypeLiteral",
"literal": "ash"
},
{
"kind": "HttpTypeLiteral",
"literal": "ballad"
},
{
"kind": "HttpTypeLiteral",
"literal": "coral"
},
{
"kind": "HttpTypeLiteral",
"literal": "echo"
},
{
"kind": "HttpTypeLiteral",
"literal": "sage"
},
{
"kind": "HttpTypeLiteral",
"literal": "shimmer"
},
{
"kind": "HttpTypeLiteral",
"literal": "verse"
},
{
"kind": "HttpTypeLiteral",
"literal": "marin"
},
{
"kind": "HttpTypeLiteral",
"literal": "cedar"
}
],
"oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1"
},
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 0",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 1",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 2",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 3",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 4",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 5",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 6",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 7",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 8",
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 9"
]
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 2": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1",
"ident": "ID",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "id"
}
]
},
"docstring": "Custom voice reference.",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 2 > (property) id"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text content.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "system"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(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.",
"key": "audio",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio",
"deprecated": 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`.",
"key": "detail",
"optional": true,
"nullable": false,
"default": "auto",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 2"
]
},
"(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.",
"key": "image_url",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url",
"deprecated": 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`).",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text",
"deprecated": 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.",
"key": "transcript",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript",
"deprecated": 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`).",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_text"
},
{
"kind": "HttpTypeLiteral",
"literal": "input_audio"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 1",
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 2"
]
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "user"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(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.",
"key": "audio",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text content.",
"key": "text",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text",
"deprecated": 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`.",
"key": "transcript",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript",
"deprecated": 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.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "output_text"
},
{
"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,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 0",
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 1"
]
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "assistant"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "message"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function_call"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function_call_output"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "realtime.item"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "completed"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "incomplete"
}
},
"(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "in_progress"
}
},
"(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_response"
}
},
"(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",
"key": "input_schema",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema",
"deprecated": 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",
"key": "name",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/name",
"deprecated": 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",
"key": "annotations",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeUnknown"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations",
"deprecated": false,
"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",
"key": "description",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPListToolsTool/properties/description",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_list_tools"
}
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_call"
}
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpProtocolError",
"$ref": "(resource) realtime > (model) realtime_mcp_protocol_error > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcpToolExecutionError",
"$ref": "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error > (variant) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeReference",
"ident": "RealtimeMcphttpError",
"$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)"
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPProtocolError",
"ident": "RealtimeMcpProtocolError",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError",
"ident": "RealtimeMcpToolExecutionError",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "message"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeMCPHTTPError",
"ident": "RealtimeMcphttpError",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "code"
},
{
"ident": "message"
},
{
"ident": "type"
}
]
},
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message",
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type"
]
},
"(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp_approval_request"
}
},
"(resource) responses > (model) response_input_text > (schema) > (property) text": {
"kind": "HttpDeclProperty",
"docstring": "The text input to the model.",
"key": "text",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputTextContent/properties/text",
"deprecated": 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`.",
"key": "type",
"optional": false,
"nullable": false,
"default": "input_text",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
],
"oasRef": "#/components/schemas/InputTextContent/properties/type"
},
"oasRef": "#/components/schemas/InputTextContent/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "prompt_cache_breakpoint",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "mode"
}
]
},
"oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode"
]
},
"(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`.",
"key": "detail",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
},
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "original"
}
],
"oasRef": "#/components/schemas/InputImageContent/properties/detail"
},
"oasRef": "#/components/schemas/InputImageContent/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 0",
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 1",
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 2",
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 3"
]
},
"(resource) responses > (model) response_input_image > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the input item. Always `input_image`.",
"key": "type",
"optional": false,
"nullable": false,
"default": "input_image",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_image"
}
],
"oasRef": "#/components/schemas/InputImageContent/properties/type"
},
"oasRef": "#/components/schemas/InputImageContent/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) type > (member) 0"
]
},
"(resource) responses > (model) response_input_image > (schema) > (property) file_id": {
"kind": "HttpDeclProperty",
"docstring": "The ID of the file to be sent to the model.",
"key": "file_id",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputImageContent/properties/file_id",
"deprecated": false,
"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.",
"key": "image_url",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/InputImageContent/properties/image_url",
"deprecated": false,
"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.",
"key": "prompt_cache_breakpoint",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "mode"
}
]
},
"oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode"
]
},
"(resource) responses > (model) response_input_file > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The type of the input item. Always `input_file`.",
"key": "type",
"optional": false,
"nullable": false,
"default": "input_file",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "input_file"
}
],
"oasRef": "#/components/schemas/InputFileContent/properties/type"
},
"oasRef": "#/components/schemas/InputFileContent/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) type > (member) 0"
]
},
"(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`.",
"key": "detail",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "auto"
},
{
"kind": "HttpTypeLiteral",
"literal": "low"
},
{
"kind": "HttpTypeLiteral",
"literal": "high"
}
],
"oasRef": "#/components/schemas/InputFileContent/properties/detail"
},
"oasRef": "#/components/schemas/InputFileContent/properties/detail",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 0",
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 1",
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 2"
]
},
"(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",
"key": "file_data",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputFileContent/properties/file_data",
"deprecated": 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.",
"key": "file_id",
"optional": true,
"nullable": true,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputFileContent/properties/file_id",
"deprecated": false,
"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.",
"key": "file_url",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"format": "uri"
},
"oasRef": "#/components/schemas/InputFileContent/properties/file_url",
"deprecated": 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.",
"key": "filename",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/InputFileContent/properties/filename",
"deprecated": 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.",
"key": "prompt_cache_breakpoint",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "mode"
}
]
},
"oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode"
]
},
"(resource) responses > (model) tool_choice_function > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) responses > (model) tool_choice_mcp > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
},
"(resource) realtime > (model) realtime_function_tool > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "function"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "mcp"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "direct"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers > (items) > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "programmatic"
}
},
"(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",
"ident": "McpAllowedTools",
"type": {
"kind": "HttpTypeArray",
"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",
"ident": "McpToolFilter",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
},
"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",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_dropbox"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_gmail"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_googlecalendar"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_googledrive"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_microsoftteams"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_outlookcalendar"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_outlookemail"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "connector_sharepoint"
}
},
"(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",
"ident": "McpToolApprovalFilter",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "always"
},
{
"ident": "never"
}
]
},
"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",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never"
]
},
"(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",
"ident": "McpToolApprovalSetting",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "always"
},
{
"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",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": {
"kind": "HttpDeclProperty",
"docstring": "The sample rate of the audio. Always `24000`.",
"key": "rate",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": 24000
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The audio format. Always `audio/pcm`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "audio/pcm"
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The audio format. Always `audio/pcmu`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "audio/pcmu"
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The audio format. Always `audio/pcma`.",
"key": "type",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "audio/pcma"
}
],
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type"
},
"oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "alloy"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "ash"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "ballad"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "coral"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 4": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "echo"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 5": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "sage"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 6": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "shimmer"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 7": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "verse"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 8": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "marin"
}
},
"(resource) realtime > (model) realtime_response_create_audio_output > (schema) > (property) output > (property) voice > (variant) 1 > (member) 9": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "cedar"
}
},
"(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`.",
"key": "id",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"examples": [
"voice_1234"
],
"oasRef": "#/components/schemas/VoiceIdsOrCustomVoice/anyOf/1/properties/id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_audio"
}
},
"(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_image"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "output_text"
}
},
"(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "output_audio"
}
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": {
"kind": "HttpDeclProperty",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": {
"kind": "HttpDeclProperty",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "protocol_error"
}
],
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": {
"kind": "HttpDeclProperty",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "tool_execution_error"
}
],
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": {
"kind": "HttpDeclProperty",
"key": "code",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeNumber"
},
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code",
"deprecated": false,
"schemaType": "integer",
"children": []
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": {
"kind": "HttpDeclProperty",
"key": "message",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "http_error"
}
],
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type"
},
"oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type > (member) 0"
]
},
"(resource) responses > (model) response_input_text > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_text"
}
},
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode": {
"kind": "HttpDeclProperty",
"docstring": "The breakpoint mode. Always `explicit`.",
"key": "mode",
"optional": false,
"nullable": false,
"default": "explicit",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
],
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode"
},
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0"
]
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) detail > (member) 3": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "original"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_image"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode": {
"kind": "HttpDeclProperty",
"docstring": "The breakpoint mode. Always `explicit`.",
"key": "mode",
"optional": false,
"nullable": false,
"default": "explicit",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
],
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode"
},
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0"
]
},
"(resource) responses > (model) response_input_file > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "input_file"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "auto"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "low"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) detail > (member) 2": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "high"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode": {
"kind": "HttpDeclProperty",
"docstring": "The breakpoint mode. Always `explicit`.",
"key": "mode",
"optional": false,
"nullable": false,
"default": "explicit",
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
],
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode"
},
"oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0"
]
},
"(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",
"key": "read_only",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/read_only",
"deprecated": 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.",
"key": "tool_names",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names",
"deprecated": 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",
"key": "always",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
},
"oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names"
]
},
"(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",
"key": "never",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "read_only"
},
{
"ident": "tool_names"
}
]
},
"oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never",
"deprecated": false,
"schemaType": "object",
"childrenParentSchema": "object",
"children": [
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only",
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names"
]
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "always"
}
},
"(resource) realtime > (model) realtime_response_create_params > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 1": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "never"
}
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": 24000
}
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio/pcm"
}
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio/pcmu"
}
},
"(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "audio/pcma"
}
},
"(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "protocol_error"
}
},
"(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "tool_execution_error"
}
},
"(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "http_error"
}
},
"(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
},
"(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
},
"(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "explicit"
}
},
"(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",
"key": "read_only",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/read_only",
"deprecated": 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.",
"key": "tool_names",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names",
"deprecated": 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",
"key": "read_only",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeBoolean"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/read_only",
"deprecated": 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.",
"key": "tool_names",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeArray",
"elementType": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names"
},
"oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names",
"deprecated": false,
"schemaType": "array",
"children": []
}
}
Example
// Trigger a response with the default Conversation and no special parameters
{
"type": "response.create",
}
// Trigger an out-of-band response that does not write to the default Conversation
{
"type": "response.create",
"response": {
"instructions": "Provide a concise answer.",
"tools": [], // clear any session tools
"conversation": "none",
"output_modalities": ["text"],
"metadata": {
"response_purpose": "summarization"
},
"input": [
{
"type": "item_reference",
"id": "item_12345"
},
{
"type": "message",
"role": "user",
"content": [
{
"type": "input_text",
"text": "Summarize the above message in one sentence."
}
]
}
]
}
}
response.cancel
Send this event to cancel an in-progress response. The server will respond
with a response.done event with a status of response.status=cancelled. If
there is no response to cancel, the server will respond with an error. It's safe
to call response.cancel even if no response is in progress, an error will be
returned the session will remain unaffected.
Schema
Schema name: RealtimeClientEventResponseCancel
{
"(resource) realtime > (model) response_cancel_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventResponseCancel",
"ident": "ResponseCancelEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "event_id"
},
{
"ident": "response_id"
}
]
},
"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",
"(resource) realtime > (model) response_cancel_event > (schema) > (property) event_id",
"(resource) realtime > (model) response_cancel_event > (schema) > (property) response_id"
]
},
"(resource) realtime > (model) response_cancel_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The event type, must be `response.cancel`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "response.cancel"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) response_cancel_event > (schema) > (property) type > (member) 0"
]
},
"(resource) realtime > (model) response_cancel_event > (schema) > (property) event_id": {
"kind": "HttpDeclProperty",
"docstring": "Optional client-generated ID used to identify this event.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"constraints": {
"maxLength": 512
},
"oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/event_id",
"deprecated": 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",
"key": "response_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeClientEventResponseCancel/properties/response_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) response_cancel_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "response.cancel"
}
}
}
Example
{
"type": "response.cancel",
"response_id": "resp_12345"
}
output_audio_buffer.clear
WebRTC/SIP Only: Emit to cut off the current audio response. This will trigger the server to
stop generating audio and emit a output_audio_buffer.cleared event. This
event should be preceded by a response.cancel client event to stop the
generation of the current response.
Learn more.
Schema
Schema name: RealtimeClientEventOutputAudioBufferClear
{
"(resource) realtime > (model) output_audio_buffer_clear_event > (schema)": {
"kind": "HttpDeclTypeAlias",
"oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear",
"ident": "OutputAudioBufferClearEvent",
"type": {
"kind": "HttpTypeObject",
"members": [
{
"ident": "type"
},
{
"ident": "event_id"
}
]
},
"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",
"(resource) realtime > (model) output_audio_buffer_clear_event > (schema) > (property) event_id"
]
},
"(resource) realtime > (model) output_audio_buffer_clear_event > (schema) > (property) type": {
"kind": "HttpDeclProperty",
"docstring": "The event type, must be `output_audio_buffer.clear`.",
"key": "type",
"optional": false,
"nullable": false,
"type": {
"kind": "HttpTypeUnion",
"types": [
{
"kind": "HttpTypeLiteral",
"literal": "output_audio_buffer.clear"
}
],
"oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/type"
},
"oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/type",
"deprecated": false,
"schemaType": "enum",
"childrenParentSchema": "enum",
"children": [
"(resource) realtime > (model) output_audio_buffer_clear_event > (schema) > (property) type > (member) 0"
]
},
"(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.",
"key": "event_id",
"optional": true,
"nullable": false,
"type": {
"kind": "HttpTypeString"
},
"oasRef": "#/components/schemas/RealtimeClientEventOutputAudioBufferClear/properties/event_id",
"deprecated": false,
"schemaType": "string",
"children": []
},
"(resource) realtime > (model) output_audio_buffer_clear_event > (schema) > (property) type > (member) 0": {
"kind": "HttpDeclReference",
"type": {
"kind": "HttpTypeLiteral",
"literal": "output_audio_buffer.clear"
}
}
}
Example
{
"event_id": "optional_client_event_id",
"type": "output_audio_buffer.clear"
}