diff --git a/en/resources/realtime/server-events.md b/en/resources/realtime/server-events.md index a41b361f..6bd47093 100644 --- a/en/resources/realtime/server-events.md +++ b/en/resources/realtime/server-events.md @@ -1,5 +1,7 @@ # Realtime server events +> For the complete documentation index, see [llms.txt](/llms.txt). Markdown versions of documentation pages are available by appending `.md` to the page URL. + These are events emitted from the OpenAI Realtime WebSocket server to the client. ## conversation.created @@ -15,6 +17,7 @@ Schema name: `RealtimeServerEventConversationCreated` "(resource) realtime > (model) conversation_created_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated", + "docstring": "Returned when a conversation is created. Emitted right after session creation.\n", "ident": "ConversationCreatedEvent", "type": { "kind": "HttpTypeObject", @@ -30,7 +33,6 @@ Schema name: `RealtimeServerEventConversationCreated` } ] }, - "docstring": "Returned when a conversation is created. Emitted right after session creation.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_created_event > (schema) > (property) conversation", @@ -40,10 +42,10 @@ Schema name: `RealtimeServerEventConversationCreated` }, "(resource) realtime > (model) conversation_created_event > (schema) > (property) conversation": { "kind": "HttpDeclProperty", - "docstring": "The conversation resource.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation", + "deprecated": false, "key": "conversation", - "optional": false, - "nullable": false, + "docstring": "The conversation resource.", "type": { "kind": "HttpTypeObject", "members": [ @@ -55,8 +57,8 @@ Schema name: `RealtimeServerEventConversationCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -66,36 +68,36 @@ Schema name: `RealtimeServerEventConversationCreated` }, "(resource) realtime > (model) conversation_created_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_created_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.created`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.created`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.created" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -104,29 +106,29 @@ Schema name: `RealtimeServerEventConversationCreated` }, "(resource) realtime > (model) conversation_created_event > (schema) > (property) conversation > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the conversation.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the conversation.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_created_event > (schema) > (property) conversation > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, must be `realtime.conversation`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "The object type, must be `realtime.conversation`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationCreated/properties/conversation/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -174,6 +176,7 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) conversation_item_created_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated", + "docstring": "Returned when a conversation item is created. There are several scenarios that produce this event:\n - The server is generating a Response, which if successful will produce\n either one or two Items, which will be of type `message`\n (role `assistant`) or type `function_call`.\n - The input audio buffer has been committed, either by the client or the\n server (in `server_vad` mode). The server will take the content of the\n input audio buffer and add it to a new user message Item.\n - The client has sent a `conversation.item.create` event to add a new Item\n to the Conversation.\n", "ident": "ConversationItemCreatedEvent", "type": { "kind": "HttpTypeObject", @@ -192,7 +195,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "docstring": "Returned when a conversation item is created. There are several scenarios that produce this event:\n - The server is generating a Response, which if successful will produce\n either one or two Items, which will be of type `message`\n (role `assistant`) or type `function_call`.\n - The input audio buffer has been committed, either by the client or the\n server (in `server_vad` mode). The server will take the content of the\n input audio buffer and add it to a new user message Item.\n - The client has sent a `conversation.item.create` event to add a new Item\n to the Conversation.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_created_event > (schema) > (property) event_id", @@ -203,33 +205,33 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) conversation_item_created_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_created_event > (schema) > (property) item": { "kind": "HttpDeclProperty", - "docstring": "A single item within a Realtime conversation.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/item", + "deprecated": false, "key": "item", - "optional": false, - "nullable": false, + "docstring": "A single item within a Realtime conversation.", "type": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/item", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) conversation_item", "childrenParentSchema": "union", "children": [ @@ -246,22 +248,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) conversation_item_created_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.created`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.created`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.created" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -270,15 +272,15 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) conversation_item_created_event > (schema) > (property) previous_item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the preceding item in the Conversation context, allows the\nclient to understand the order of the conversation. Can be `null` if the\nitem has no predecessor.\n", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/previous_item_id", + "deprecated": false, "key": "previous_item_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the preceding item in the Conversation context, allows the\nclient to understand the order of the conversation. Can be `null` if the\nitem has no predecessor.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemCreated/properties/previous_item_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -437,9 +439,11 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -486,10 +490,8 @@ Schema name: `RealtimeServerEventConversationItemCreated` "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", @@ -512,12 +514,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -528,11 +531,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -542,22 +544,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -566,22 +568,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -590,36 +592,36 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -628,12 +630,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -647,11 +650,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -663,6 +665,7 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -687,7 +690,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "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", @@ -700,12 +702,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -728,11 +731,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -746,22 +748,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -770,22 +772,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -794,36 +796,36 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -832,12 +834,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -851,11 +854,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -867,6 +869,7 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -891,7 +894,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -904,12 +906,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -926,11 +929,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -942,22 +944,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -966,22 +968,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -990,36 +992,36 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1028,12 +1030,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -1047,11 +1050,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1063,6 +1065,7 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -1087,7 +1090,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -1100,50 +1102,50 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1152,50 +1154,50 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1204,12 +1206,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -1223,11 +1226,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1239,6 +1241,7 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -1266,7 +1269,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -1280,50 +1282,50 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1332,36 +1334,36 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1370,12 +1372,13 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -1389,11 +1392,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1405,6 +1407,7 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -1429,7 +1432,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "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", @@ -1442,64 +1444,64 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1508,21 +1510,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -1544,7 +1547,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -1556,26 +1558,27 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -1592,11 +1595,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -1608,22 +1610,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1632,21 +1634,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -1665,7 +1668,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "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", @@ -1676,78 +1678,78 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1756,26 +1758,27 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -1792,11 +1795,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -1807,21 +1809,22 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -1852,7 +1855,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "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", @@ -1867,78 +1869,78 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -1948,6 +1950,7 @@ Schema name: `RealtimeServerEventConversationItemCreated` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -1969,7 +1972,6 @@ Schema name: `RealtimeServerEventConversationItemCreated` } ] }, - "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", @@ -1981,36 +1983,36 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2061,27 +2063,27 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -2095,11 +2097,11 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2110,57 +2112,58 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -2174,11 +2177,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2231,54 +2233,55 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -2288,11 +2291,10 @@ Schema name: `RealtimeServerEventConversationItemCreated` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2421,57 +2423,57 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -2673,47 +2675,47 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2722,34 +2724,34 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2758,47 +2760,47 @@ Schema name: `RealtimeServerEventConversationItemCreated` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2862,6 +2864,7 @@ Schema name: `RealtimeServerEventConversationItemDeleted` "(resource) realtime > (model) conversation_item_deleted_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted", + "docstring": "Returned when an item in the conversation is deleted by the client with a \n`conversation.item.delete` event. This event is used to synchronize the \nserver's understanding of the conversation history with the client's view.\n", "ident": "ConversationItemDeletedEvent", "type": { "kind": "HttpTypeObject", @@ -2877,7 +2880,6 @@ Schema name: `RealtimeServerEventConversationItemDeleted` } ] }, - "docstring": "Returned when an item in the conversation is deleted by the client with a \n`conversation.item.delete` event. This event is used to synchronize the \nserver's understanding of the conversation history with the client's view.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_deleted_event > (schema) > (property) event_id", @@ -2887,50 +2889,50 @@ Schema name: `RealtimeServerEventConversationItemDeleted` }, "(resource) realtime > (model) conversation_item_deleted_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_deleted_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item that was deleted.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item that was deleted.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_deleted_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.deleted`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.deleted`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.deleted" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDeleted/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -2979,6 +2981,7 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted", + "docstring": "This event is the output of audio transcription for user audio written to the\nuser audio buffer. Transcription begins when the input audio buffer is\ncommitted by the client or server (when VAD is enabled). Transcription runs\nasynchronously with Response creation, so this event may come before or after\nthe Response events.\n\nRealtime API models accept audio natively, and thus input transcription is a\nseparate process run on a separate ASR (Automatic Speech Recognition) model.\nThe transcript may diverge somewhat from the model's interpretation, and\nshould be treated as a rough guide.\n", "ident": "ConversationItemInputAudioTranscriptionCompletedEvent", "type": { "kind": "HttpTypeObject", @@ -3001,12 +3004,14 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete { "ident": "usage" }, + { + "ident": "languages" + }, { "ident": "logprobs" } ] }, - "docstring": "This event is the output of audio transcription for user audio written to the\nuser audio buffer. Transcription begins when the input audio buffer is\ncommitted by the client or server (when VAD is enabled). Transcription runs\nasynchronously with Response creation, so this event may come before or after\nthe Response events.\n\nRealtime API models accept audio natively, and thus input transcription is a\nseparate process run on a separate ASR (Automatic Speech Recognition) model.\nThe transcript may diverge somewhat from the model's interpretation, and\nshould be treated as a rough guide.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) content_index", @@ -3015,83 +3020,84 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) transcript", "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) type", "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage", + "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) languages", "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) logprobs" ] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part containing the audio.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part containing the audio.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item containing the audio that is being transcribed.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item containing the audio that is being transcribed.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcribed text.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": false, - "nullable": false, + "docstring": "The transcribed text.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/transcript", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be\n`conversation.item.input_audio_transcription.completed`.\n", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be\n`conversation.item.input_audio_transcription.completed`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.input_audio_transcription.completed" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3100,12 +3106,13 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics for the transcription, this is billed according to the ASR model's pricing rather than the realtime model's pricing.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage", + "deprecated": false, "key": "usage", - "optional": false, - "nullable": false, + "docstring": "Usage statistics for the transcription, this is billed according to the ASR model's pricing rather than the realtime model's pricing.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage", "types": [ { "kind": "HttpTypeObject", @@ -3138,11 +3145,10 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete } ] } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -3150,23 +3156,46 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 1" ] }, + "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) languages": { + "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/languages", + "deprecated": false, + "key": "languages", + "docstring": "The languages detected in the audio. Returned by `gpt-transcribe`. An empty array indicates that no language could be reliably detected.\n", + "type": { + "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/languages", + "elementType": { + "kind": "HttpTypeReference", + "ident": "TranscriptionLanguage", + "$ref": "(resource) audio.transcriptions > (model) transcription_language > (schema)" + } + }, + "optional": true, + "nullable": false, + "schemaType": "array", + "childrenParentSchema": "object", + "children": [ + "(resource) audio.transcriptions > (model) transcription_language > (schema) > (property) code" + ] + }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) logprobs": { "kind": "HttpDeclProperty", - "docstring": "The log probabilities of the transcription.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/logprobs", + "deprecated": false, "key": "logprobs", - "optional": true, - "nullable": true, + "docstring": "The log probabilities of the transcription.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/logprobs", "elementType": { "kind": "HttpTypeReference", "ident": "LogProbProperties", "$ref": "(resource) realtime > (model) log_prob_properties > (schema)" + } }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/logprobs" - }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/logprobs", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -3185,7 +3214,8 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage/oneOf/0", - "ident": "TokenUsage", + "docstring": "Usage statistics for models billed by token usage.", + "ident": "Tokens", "type": { "kind": "HttpTypeObject", "members": [ @@ -3206,7 +3236,6 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete } ] }, - "docstring": "Usage statistics for models billed by token usage.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) input_tokens", @@ -3219,7 +3248,8 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionCompleted/properties/usage/oneOf/1", - "ident": "DurationUsage", + "docstring": "Usage statistics for models billed by audio input duration.", + "ident": "Duration", "type": { "kind": "HttpTypeObject", "members": [ @@ -3231,62 +3261,94 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete } ] }, - "docstring": "Usage statistics for models billed by audio input duration.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 1 > (property) seconds", "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 1 > (property) type" ] }, - "(resource) realtime > (model) log_prob_properties > (schema) > (property) token": { + "(resource) audio.transcriptions > (model) transcription_language > (schema) > (property) code": { "kind": "HttpDeclProperty", - "docstring": "The token that was used to generate the log probability.\n", - "key": "token", + "oasRef": "#/components/schemas/TranscriptionLanguage/properties/code", + "deprecated": false, + "key": "code", + "docstring": "The code of a language detected in the audio.", + "type": { + "kind": "HttpTypeString" + }, "optional": false, "nullable": false, + "schemaType": "string", + "children": [] + }, + "(resource) audio.transcriptions > (model) transcription_language > (schema)": { + "kind": "HttpDeclTypeAlias", + "oasRef": "#/components/schemas/TranscriptionLanguage", + "docstring": "A language detected in transcribed audio.", + "ident": "TranscriptionLanguage", "type": { - "kind": "HttpTypeString" + "kind": "HttpTypeObject", + "members": [ + { + "ident": "code" + } + ] }, + "childrenParentSchema": "object", + "children": [ + "(resource) audio.transcriptions > (model) transcription_language > (schema) > (property) code" + ] + }, + "(resource) realtime > (model) log_prob_properties > (schema) > (property) token": { + "kind": "HttpDeclProperty", "oasRef": "#/components/schemas/LogProbProperties/properties/token", "deprecated": false, + "key": "token", + "docstring": "The token that was used to generate the log probability.\n", + "type": { + "kind": "HttpTypeString" + }, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) log_prob_properties > (schema) > (property) bytes": { "kind": "HttpDeclProperty", - "docstring": "The bytes that were used to generate the log probability.\n", + "oasRef": "#/components/schemas/LogProbProperties/properties/bytes", + "deprecated": false, "key": "bytes", - "optional": false, - "nullable": false, + "docstring": "The bytes that were used to generate the log probability.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/LogProbProperties/properties/bytes", "elementType": { "kind": "HttpTypeNumber" + } }, - "oasRef": "#/components/schemas/LogProbProperties/properties/bytes" - }, - "oasRef": "#/components/schemas/LogProbProperties/properties/bytes", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime > (model) log_prob_properties > (schema) > (property) logprob": { "kind": "HttpDeclProperty", - "docstring": "The log probability of the token.\n", + "oasRef": "#/components/schemas/LogProbProperties/properties/logprob", + "deprecated": false, "key": "logprob", - "optional": false, - "nullable": false, + "docstring": "The log probability of the token.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/LogProbProperties/properties/logprob", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) log_prob_properties > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/LogProbProperties", + "docstring": "A log probability object.\n", "ident": "LogProbProperties", "type": { "kind": "HttpTypeObject", @@ -3302,7 +3364,6 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete } ] }, - "docstring": "A log probability object.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) log_prob_properties > (schema) > (property) token", @@ -3312,64 +3373,64 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) input_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of input tokens billed for this request.", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_tokens", + "deprecated": false, "key": "input_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of input tokens billed for this request.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) output_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of output tokens generated.", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/output_tokens", + "deprecated": false, "key": "output_tokens", - "optional": false, - "nullable": false, + "docstring": "Number of output tokens generated.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/output_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "Total number of tokens used (input + output).", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": false, - "nullable": false, + "docstring": "Total number of tokens used (input + output).", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/total_tokens", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the usage object. Always `tokens` for this variant.", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the usage object. Always `tokens` for this variant.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tokens" } - ], - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/type" + ] }, - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3378,10 +3439,10 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) input_token_details": { "kind": "HttpDeclProperty", - "docstring": "Details about the input tokens billed for this request.", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details", + "deprecated": false, "key": "input_token_details", - "optional": true, - "nullable": false, + "docstring": "Details about the input tokens billed for this request.", "type": { "kind": "HttpTypeObject", "members": [ @@ -3393,8 +3454,8 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete } ] }, - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3404,39 +3465,39 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 1 > (property) seconds": { "kind": "HttpDeclProperty", - "docstring": "Duration of the input audio in seconds.", + "oasRef": "#/components/schemas/TranscriptTextUsageDuration/properties/seconds", + "deprecated": false, "key": "seconds", - "optional": false, - "nullable": false, + "docstring": "Duration of the input audio in seconds.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "double" }, - "oasRef": "#/components/schemas/TranscriptTextUsageDuration/properties/seconds", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the usage object. Always `duration` for this variant.", + "oasRef": "#/components/schemas/TranscriptTextUsageDuration/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the usage object. Always `duration` for this variant.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/TranscriptTextUsageDuration/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "duration" } - ], - "oasRef": "#/components/schemas/TranscriptTextUsageDuration/properties/type" + ] }, - "oasRef": "#/components/schemas/TranscriptTextUsageDuration/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3452,29 +3513,29 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionComplete }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) input_token_details > (property) audio_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of audio tokens billed for this request.", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details/properties/audio_tokens", + "deprecated": false, "key": "audio_tokens", - "optional": true, - "nullable": false, + "docstring": "Number of audio tokens billed for this request.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details/properties/audio_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_completed_event > (schema) > (property) usage > (variant) 0 > (property) input_token_details > (property) text_tokens": { "kind": "HttpDeclProperty", - "docstring": "Number of text tokens billed for this request.", + "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details/properties/text_tokens", + "deprecated": false, "key": "text_tokens", - "optional": true, - "nullable": false, + "docstring": "Number of text tokens billed for this request.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/TranscriptTextUsageTokens/properties/input_token_details/properties/text_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, @@ -3523,6 +3584,7 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionDelta` "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta", + "docstring": "Returned when the text value of an input audio transcription content part is updated with incremental transcription results.\n", "ident": "ConversationItemInputAudioTranscriptionDeltaEvent", "type": { "kind": "HttpTypeObject", @@ -3547,7 +3609,6 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionDelta` } ] }, - "docstring": "Returned when the text value of an input audio transcription content part is updated with incremental transcription results.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema) > (property) event_id", @@ -3560,50 +3621,50 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionDelta` }, "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item containing the audio that is being transcribed.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item containing the audio that is being transcribed.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.input_audio_transcription.delta`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.input_audio_transcription.delta`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.input_audio_transcription.delta" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3612,49 +3673,49 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionDelta` }, "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": true, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/content_index", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "The text delta.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/delta", + "deprecated": false, "key": "delta", - "optional": true, - "nullable": false, + "docstring": "The text delta.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/delta", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_delta_event > (schema) > (property) logprobs": { "kind": "HttpDeclProperty", - "docstring": "The log probabilities of the transcription. These can be enabled by configurating the session with `\"include\": [\"item.input_audio_transcription.logprobs\"]`. Each entry in the array corresponds a log probability of which token would be selected for this chunk of transcription. This can help to identify if it was possible there were multiple valid options for a given chunk of transcription.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/logprobs", + "deprecated": false, "key": "logprobs", - "optional": true, - "nullable": true, + "docstring": "The log probabilities of the transcription. These can be enabled by configurating the session with `\"include\": [\"item.input_audio_transcription.logprobs\"]`. Each entry in the array corresponds a log probability of which token would be selected for this chunk of transcription. This can help to identify if it was possible there were multiple valid options for a given chunk of transcription.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/logprobs", "elementType": { "kind": "HttpTypeReference", "ident": "LogProbProperties", "$ref": "(resource) realtime > (model) log_prob_properties > (schema)" + } }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/logprobs" - }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionDelta/properties/logprobs", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -3672,53 +3733,54 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionDelta` }, "(resource) realtime > (model) log_prob_properties > (schema) > (property) token": { "kind": "HttpDeclProperty", - "docstring": "The token that was used to generate the log probability.\n", + "oasRef": "#/components/schemas/LogProbProperties/properties/token", + "deprecated": false, "key": "token", - "optional": false, - "nullable": false, + "docstring": "The token that was used to generate the log probability.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/LogProbProperties/properties/token", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) log_prob_properties > (schema) > (property) bytes": { "kind": "HttpDeclProperty", - "docstring": "The bytes that were used to generate the log probability.\n", + "oasRef": "#/components/schemas/LogProbProperties/properties/bytes", + "deprecated": false, "key": "bytes", - "optional": false, - "nullable": false, + "docstring": "The bytes that were used to generate the log probability.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/LogProbProperties/properties/bytes", "elementType": { "kind": "HttpTypeNumber" + } }, - "oasRef": "#/components/schemas/LogProbProperties/properties/bytes" - }, - "oasRef": "#/components/schemas/LogProbProperties/properties/bytes", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime > (model) log_prob_properties > (schema) > (property) logprob": { "kind": "HttpDeclProperty", - "docstring": "The log probability of the token.\n", + "oasRef": "#/components/schemas/LogProbProperties/properties/logprob", + "deprecated": false, "key": "logprob", - "optional": false, - "nullable": false, + "docstring": "The log probability of the token.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/LogProbProperties/properties/logprob", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) log_prob_properties > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/LogProbProperties", + "docstring": "A log probability object.\n", "ident": "LogProbProperties", "type": { "kind": "HttpTypeObject", @@ -3734,7 +3796,6 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionDelta` } ] }, - "docstring": "A log probability object.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) log_prob_properties > (schema) > (property) token", @@ -3773,6 +3834,7 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionFailed` "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed", + "docstring": "Returned when input audio transcription is configured, and a transcription \nrequest for a user message failed. These events are separate from other \n`error` events so that the client can identify the related Item.\n", "ident": "ConversationItemInputAudioTranscriptionFailedEvent", "type": { "kind": "HttpTypeObject", @@ -3794,7 +3856,6 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionFailed` } ] }, - "docstring": "Returned when input audio transcription is configured, and a transcription \nrequest for a user message failed. These events are separate from other \n`error` events so that the client can identify the related Item.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) content_index", @@ -3806,24 +3867,24 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionFailed` }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part containing the audio.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part containing the audio.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "Details of the transcription error.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error", + "deprecated": false, "key": "error", - "optional": false, - "nullable": false, + "docstring": "Details of the transcription error.", "type": { "kind": "HttpTypeObject", "members": [ @@ -3841,8 +3902,8 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionFailed` } ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -3854,50 +3915,50 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionFailed` }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the user message item.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the user message item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be\n`conversation.item.input_audio_transcription.failed`.\n", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be\n`conversation.item.input_audio_transcription.failed`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.input_audio_transcription.failed" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -3906,57 +3967,57 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionFailed` }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "Error code, if any.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/code", + "deprecated": false, "key": "code", - "optional": true, - "nullable": false, + "docstring": "Error code, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/code", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) error > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable error message.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/message", + "deprecated": false, "key": "message", - "optional": true, - "nullable": false, + "docstring": "A human-readable error message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/message", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) error > (property) param": { "kind": "HttpDeclProperty", - "docstring": "Parameter related to the error, if any.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/param", + "deprecated": false, "key": "param", - "optional": true, - "nullable": false, + "docstring": "Parameter related to the error, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/param", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_failed_event > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of error.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionFailed/properties/error/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -4000,6 +4061,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 6": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEvent/anyOf/6", + "docstring": "Returned when a conversation item is retrieved with `conversation.item.retrieve`. This is provided as a way to fetch the server's representation of an item, for example to get access to the post-processed audio data after noise cancellation and VAD. It includes the full content of the Item, including audio data.\n", "ident": "ConversationItemRetrieved", "type": { "kind": "HttpTypeObject", @@ -4015,7 +4077,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "Returned when a conversation item is retrieved with `conversation.item.retrieve`. This is provided as a way to fetch the server's representation of an item, for example to get access to the post-processed audio data after noise cancellation and VAD. It includes the full content of the Item, including audio data.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 6 > (property) event_id", @@ -4025,33 +4086,33 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 6 > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 6 > (property) item": { "kind": "HttpDeclProperty", - "docstring": "A single item within a Realtime conversation.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/item", + "deprecated": false, "key": "item", - "optional": false, - "nullable": false, + "docstring": "A single item within a Realtime conversation.", "type": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/item", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) conversation_item", "childrenParentSchema": "union", "children": [ @@ -4068,22 +4129,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 6 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.retrieved`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.retrieved`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.retrieved" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemRetrieved/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4245,9 +4306,11 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -4294,10 +4357,8 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "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", @@ -4320,12 +4381,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -4336,11 +4398,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -4350,22 +4411,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4374,22 +4435,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4398,36 +4459,36 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4436,12 +4497,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -4455,11 +4517,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4471,6 +4532,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -4495,7 +4557,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "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", @@ -4508,12 +4569,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -4536,11 +4598,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -4554,22 +4615,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4578,22 +4639,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4602,36 +4663,36 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4640,12 +4701,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -4659,11 +4721,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4675,6 +4736,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -4699,7 +4761,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -4712,12 +4773,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -4734,11 +4796,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -4750,22 +4811,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4774,22 +4835,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4798,36 +4859,36 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4836,12 +4897,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -4855,11 +4917,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4871,6 +4932,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -4895,7 +4957,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -4908,50 +4969,50 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -4960,50 +5021,50 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5012,12 +5073,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -5031,11 +5093,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5047,6 +5108,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -5074,7 +5136,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -5088,50 +5149,50 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5140,36 +5201,36 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5178,12 +5239,13 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -5197,11 +5259,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5213,6 +5274,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -5237,7 +5299,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "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", @@ -5250,64 +5311,64 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5316,21 +5377,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -5352,7 +5414,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -5364,26 +5425,27 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -5400,11 +5462,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -5416,22 +5477,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5440,21 +5501,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -5473,7 +5535,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "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", @@ -5484,78 +5545,78 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5564,26 +5625,27 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -5600,11 +5662,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -5615,21 +5676,22 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -5660,7 +5722,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "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", @@ -5675,78 +5736,78 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5756,6 +5817,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -5777,7 +5839,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "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", @@ -5789,36 +5850,36 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5869,27 +5930,27 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -5903,11 +5964,11 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -5918,57 +5979,58 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -5982,11 +6044,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6039,54 +6100,55 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -6096,11 +6158,10 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6229,57 +6290,57 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -6481,47 +6542,47 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6530,34 +6591,34 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6566,47 +6627,47 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6661,6 +6722,7 @@ Schema name: `RealtimeServerEventConversationItemTruncated` "(resource) realtime > (model) conversation_item_truncated_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated", + "docstring": "Returned when an earlier assistant audio message item is truncated by the \nclient with a `conversation.item.truncate` event. This event is used to \nsynchronize the server's understanding of the audio with the client's playback.\n\nThis action will truncate the audio and remove the server-side text transcript \nto ensure there is no text in the context that hasn't been heard by the user.\n", "ident": "ConversationItemTruncatedEvent", "type": { "kind": "HttpTypeObject", @@ -6682,7 +6744,6 @@ Schema name: `RealtimeServerEventConversationItemTruncated` } ] }, - "docstring": "Returned when an earlier assistant audio message item is truncated by the \nclient with a `conversation.item.truncate` event. This event is used to \nsynchronize the server's understanding of the audio with the client's playback.\n\nThis action will truncate the audio and remove the server-side text transcript \nto ensure there is no text in the context that hasn't been heard by the user.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_truncated_event > (schema) > (property) audio_end_ms", @@ -6694,78 +6755,78 @@ Schema name: `RealtimeServerEventConversationItemTruncated` }, "(resource) realtime > (model) conversation_item_truncated_event > (schema) > (property) audio_end_ms": { "kind": "HttpDeclProperty", - "docstring": "The duration up to which the audio was truncated, in milliseconds.\n", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/audio_end_ms", + "deprecated": false, "key": "audio_end_ms", - "optional": false, - "nullable": false, + "docstring": "The duration up to which the audio was truncated, in milliseconds.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/audio_end_ms", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_truncated_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part that was truncated.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part that was truncated.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_truncated_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_truncated_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the assistant message item that was truncated.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the assistant message item that was truncated.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_truncated_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.truncated`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.truncated`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.truncated" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemTruncated/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6809,6 +6870,7 @@ Schema name: `RealtimeServerEventError` "(resource) realtime > (model) realtime_error_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventError", + "docstring": "Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n", "ident": "RealtimeErrorEvent", "type": { "kind": "HttpTypeObject", @@ -6824,7 +6886,6 @@ Schema name: `RealtimeServerEventError` } ] }, - "docstring": "Returned when an error occurs, which could be a client problem or a server\nproblem. Most errors are recoverable and the session will stay open, we\nrecommend to implementors to monitor and log error messages by default.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_error_event > (schema) > (property) error", @@ -6834,19 +6895,19 @@ Schema name: `RealtimeServerEventError` }, "(resource) realtime > (model) realtime_error_event > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "Details of the error.", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error", + "deprecated": false, "key": "error", - "optional": false, - "nullable": false, + "docstring": "Details of the error.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeError", "$ref": "(resource) realtime > (model) realtime_error > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_error", "childrenParentSchema": "object", "children": [ @@ -6859,36 +6920,36 @@ Schema name: `RealtimeServerEventError` }, "(resource) realtime > (model) realtime_error_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_error_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `error`.", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `error`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "error" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -6897,77 +6958,78 @@ Schema name: `RealtimeServerEventError` }, "(resource) realtime > (model) realtime_error > (schema) > (property) message": { "kind": "HttpDeclProperty", - "docstring": "A human-readable error message.", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, + "docstring": "A human-readable error message.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_error > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of error (e.g., \"invalid_request_error\", \"server_error\").\n", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of error (e.g., \"invalid_request_error\", \"server_error\").\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_error > (schema) > (property) code": { "kind": "HttpDeclProperty", - "docstring": "Error code, if any.", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/code", + "deprecated": false, "key": "code", - "optional": true, - "nullable": true, + "docstring": "Error code, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/code", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_error > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The event_id of the client event that caused the error, if applicable.\n", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": true, - "nullable": true, + "docstring": "The event_id of the client event that caused the error, if applicable.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/event_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_error > (schema) > (property) param": { "kind": "HttpDeclProperty", - "docstring": "Parameter related to the error, if any.", + "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/param", + "deprecated": false, "key": "param", - "optional": true, - "nullable": true, + "docstring": "Parameter related to the error, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error/properties/param", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_error > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventError/properties/error", + "docstring": "Details of the error.", "ident": "RealtimeError", "type": { "kind": "HttpTypeObject", @@ -6989,7 +7051,6 @@ Schema name: `RealtimeServerEventError` } ] }, - "docstring": "Details of the error.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_error > (schema) > (property) message", @@ -7039,6 +7100,7 @@ Schema name: `RealtimeServerEventInputAudioBufferCleared` "(resource) realtime > (model) input_audio_buffer_cleared_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCleared", + "docstring": "Returned when the input audio buffer is cleared by the client with a \n`input_audio_buffer.clear` event.\n", "ident": "InputAudioBufferClearedEvent", "type": { "kind": "HttpTypeObject", @@ -7051,7 +7113,6 @@ Schema name: `RealtimeServerEventInputAudioBufferCleared` } ] }, - "docstring": "Returned when the input audio buffer is cleared by the client with a \n`input_audio_buffer.clear` event.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_cleared_event > (schema) > (property) event_id", @@ -7060,36 +7121,36 @@ Schema name: `RealtimeServerEventInputAudioBufferCleared` }, "(resource) realtime > (model) input_audio_buffer_cleared_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCleared/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCleared/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_cleared_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.cleared`.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCleared/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.cleared`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCleared/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.cleared" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCleared/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCleared/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7131,6 +7192,7 @@ Schema name: `RealtimeServerEventInputAudioBufferCommitted` "(resource) realtime > (model) input_audio_buffer_committed_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted", + "docstring": "Returned when an input audio buffer is committed, either by the client or\nautomatically in server VAD mode. The `item_id` property is the ID of the user\nmessage item that will be created, thus a `conversation.item.created` event\nwill also be sent to the client.\n", "ident": "InputAudioBufferCommittedEvent", "type": { "kind": "HttpTypeObject", @@ -7149,7 +7211,6 @@ Schema name: `RealtimeServerEventInputAudioBufferCommitted` } ] }, - "docstring": "Returned when an input audio buffer is committed, either by the client or\nautomatically in server VAD mode. The `item_id` property is the ID of the user\nmessage item that will be created, thus a `conversation.item.created` event\nwill also be sent to the client.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_committed_event > (schema) > (property) event_id", @@ -7160,50 +7221,50 @@ Schema name: `RealtimeServerEventInputAudioBufferCommitted` }, "(resource) realtime > (model) input_audio_buffer_committed_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_committed_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the user message item that will be created.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the user message item that will be created.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_committed_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.committed`.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.committed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.committed" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7212,15 +7273,15 @@ Schema name: `RealtimeServerEventInputAudioBufferCommitted` }, "(resource) realtime > (model) input_audio_buffer_committed_event > (schema) > (property) previous_item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the preceding item after which the new item will be inserted.\nCan be `null` if the item has no predecessor.\n", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/previous_item_id", + "deprecated": false, "key": "previous_item_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the preceding item after which the new item will be inserted.\nCan be `null` if the item has no predecessor.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferCommitted/properties/previous_item_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -7261,6 +7322,7 @@ Schema name: `RealtimeServerEventInputAudioBufferDtmfEventReceived` "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived", + "docstring": "**SIP Only:** Returned when an DTMF event is received. A DTMF event is a message that\nrepresents a telephone keypad press (0–9, *, #, A–D). The `event` property\nis the keypad that the user press. The `received_at` is the UTC Unix Timestamp\nthat the server received the event.\n", "ident": "InputAudioBufferDtmfEventReceivedEvent", "type": { "kind": "HttpTypeObject", @@ -7276,7 +7338,6 @@ Schema name: `RealtimeServerEventInputAudioBufferDtmfEventReceived` } ] }, - "docstring": "**SIP Only:** Returned when an DTMF event is received. A DTMF event is a message that\nrepresents a telephone keypad press (0–9, *, #, A–D). The `event` property\nis the keypad that the user press. The `received_at` is the UTC Unix Timestamp\nthat the server received the event.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) event", @@ -7286,50 +7347,50 @@ Schema name: `RealtimeServerEventInputAudioBufferDtmfEventReceived` }, "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) event": { "kind": "HttpDeclProperty", - "docstring": "The telephone keypad that was pressed by the user.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/event", + "deprecated": false, "key": "event", - "optional": false, - "nullable": false, + "docstring": "The telephone keypad that was pressed by the user.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/event", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) received_at": { "kind": "HttpDeclProperty", - "docstring": "UTC Unix Timestamp when DTMF Event was received by server.\n", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/received_at", + "deprecated": false, "key": "received_at", - "optional": false, - "nullable": false, + "docstring": "UTC Unix Timestamp when DTMF Event was received by server.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/received_at", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) input_audio_buffer_dtmf_event_received_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.dtmf_event_received`.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.dtmf_event_received`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.dtmf_event_received" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferDtmfEventReceived/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7378,6 +7439,7 @@ Schema name: `RealtimeServerEventInputAudioBufferSpeechStarted` "(resource) realtime > (model) input_audio_buffer_speech_started_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted", + "docstring": "Sent by the server when in `server_vad` mode to indicate that speech has been \ndetected in the audio buffer. This can happen any time audio is added to the \nbuffer (unless speech is already detected). The client may want to use this \nevent to interrupt audio playback or provide visual feedback to the user. \n\nThe client should expect to receive a `input_audio_buffer.speech_stopped` event \nwhen speech stops. The `item_id` property is the ID of the user message item \nthat will be created when speech stops and will also be included in the \n`input_audio_buffer.speech_stopped` event (unless the client manually commits \nthe audio buffer during VAD activation).\n", "ident": "InputAudioBufferSpeechStartedEvent", "type": { "kind": "HttpTypeObject", @@ -7396,7 +7458,6 @@ Schema name: `RealtimeServerEventInputAudioBufferSpeechStarted` } ] }, - "docstring": "Sent by the server when in `server_vad` mode to indicate that speech has been \ndetected in the audio buffer. This can happen any time audio is added to the \nbuffer (unless speech is already detected). The client may want to use this \nevent to interrupt audio playback or provide visual feedback to the user. \n\nThe client should expect to receive a `input_audio_buffer.speech_stopped` event \nwhen speech stops. The `item_id` property is the ID of the user message item \nthat will be created when speech stops and will also be included in the \n`input_audio_buffer.speech_stopped` event (unless the client manually commits \nthe audio buffer during VAD activation).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_speech_started_event > (schema) > (property) audio_start_ms", @@ -7407,64 +7468,64 @@ Schema name: `RealtimeServerEventInputAudioBufferSpeechStarted` }, "(resource) realtime > (model) input_audio_buffer_speech_started_event > (schema) > (property) audio_start_ms": { "kind": "HttpDeclProperty", - "docstring": "Milliseconds from the start of all audio written to the buffer during the \nsession when speech was first detected. This will correspond to the \nbeginning of audio sent to the model, and thus includes the \n`prefix_padding_ms` configured in the Session.\n", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/audio_start_ms", + "deprecated": false, "key": "audio_start_ms", - "optional": false, - "nullable": false, + "docstring": "Milliseconds from the start of all audio written to the buffer during the \nsession when speech was first detected. This will correspond to the \nbeginning of audio sent to the model, and thus includes the \n`prefix_padding_ms` configured in the Session.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/audio_start_ms", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) input_audio_buffer_speech_started_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_speech_started_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the user message item that will be created when speech stops.\n", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the user message item that will be created when speech stops.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_speech_started_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.speech_started`.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.speech_started`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.speech_started" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStarted/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7507,6 +7568,7 @@ Schema name: `RealtimeServerEventInputAudioBufferSpeechStopped` "(resource) realtime > (model) input_audio_buffer_speech_stopped_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped", + "docstring": "Returned in `server_vad` mode when the server detects the end of speech in \nthe audio buffer. The server will also send an `conversation.item.created` \nevent with the user message item that is created from the audio buffer.\n", "ident": "InputAudioBufferSpeechStoppedEvent", "type": { "kind": "HttpTypeObject", @@ -7525,7 +7587,6 @@ Schema name: `RealtimeServerEventInputAudioBufferSpeechStopped` } ] }, - "docstring": "Returned in `server_vad` mode when the server detects the end of speech in \nthe audio buffer. The server will also send an `conversation.item.created` \nevent with the user message item that is created from the audio buffer.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_speech_stopped_event > (schema) > (property) audio_end_ms", @@ -7536,64 +7597,64 @@ Schema name: `RealtimeServerEventInputAudioBufferSpeechStopped` }, "(resource) realtime > (model) input_audio_buffer_speech_stopped_event > (schema) > (property) audio_end_ms": { "kind": "HttpDeclProperty", - "docstring": "Milliseconds since the session started when speech stopped. This will \ncorrespond to the end of audio sent to the model, and thus includes the \n`min_silence_duration_ms` configured in the Session.\n", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/audio_end_ms", + "deprecated": false, "key": "audio_end_ms", - "optional": false, - "nullable": false, + "docstring": "Milliseconds since the session started when speech stopped. This will \ncorrespond to the end of audio sent to the model, and thus includes the \n`min_silence_duration_ms` configured in the Session.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/audio_end_ms", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) input_audio_buffer_speech_stopped_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_speech_stopped_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the user message item that will be created.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the user message item that will be created.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_speech_stopped_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.speech_stopped`.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.speech_stopped`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.speech_stopped" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferSpeechStopped/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7637,6 +7698,7 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` "(resource) realtime > (model) rate_limits_updated_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated", + "docstring": "Emitted at the beginning of a Response to indicate the updated rate limits. \nWhen a Response is created some tokens will be \"reserved\" for the output \ntokens, the rate limits shown here reflect that reservation, which is then \nadjusted accordingly once the Response is completed.\n", "ident": "RateLimitsUpdatedEvent", "type": { "kind": "HttpTypeObject", @@ -7652,7 +7714,6 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` } ] }, - "docstring": "Emitted at the beginning of a Response to indicate the updated rate limits. \nWhen a Response is created some tokens will be \"reserved\" for the output \ntokens, the rate limits shown here reflect that reservation, which is then \nadjusted accordingly once the Response is completed.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) event_id", @@ -7662,26 +7723,27 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` }, "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) rate_limits": { "kind": "HttpDeclProperty", - "docstring": "List of rate limit information.", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits", + "deprecated": false, "key": "rate_limits", - "optional": false, - "nullable": false, + "docstring": "List of rate limit information.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -7698,11 +7760,10 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` "ident": "reset_seconds" } ] + } }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits" - }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -7714,22 +7775,22 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` }, "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `rate_limits.updated`.", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `rate_limits.updated`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "rate_limits.updated" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7738,26 +7799,27 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` }, "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) rate_limits > (items) > (property) limit": { "kind": "HttpDeclProperty", - "docstring": "The maximum allowed value for the rate limit.", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/limit", + "deprecated": false, "key": "limit", - "optional": true, - "nullable": false, + "docstring": "The maximum allowed value for the rate limit.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/limit", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) rate_limits > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the rate limit (`requests`, `tokens`).\n", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": false, + "docstring": "The name of the rate limit (`requests`, `tokens`).\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/name", "types": [ { "kind": "HttpTypeLiteral", @@ -7767,11 +7829,10 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` "kind": "HttpTypeLiteral", "literal": "tokens" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/name" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -7781,29 +7842,29 @@ Schema name: `RealtimeServerEventRateLimitsUpdated` }, "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) rate_limits > (items) > (property) remaining": { "kind": "HttpDeclProperty", - "docstring": "The remaining value before the limit is reached.", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/remaining", + "deprecated": false, "key": "remaining", - "optional": true, - "nullable": false, + "docstring": "The remaining value before the limit is reached.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/remaining", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) rate_limits_updated_event > (schema) > (property) rate_limits > (items) > (property) reset_seconds": { "kind": "HttpDeclProperty", - "docstring": "Seconds until the rate limit resets.", + "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/reset_seconds", + "deprecated": false, "key": "reset_seconds", - "optional": true, - "nullable": false, + "docstring": "Seconds until the rate limit resets.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventRateLimitsUpdated/properties/rate_limits/items/properties/reset_seconds", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, @@ -7867,6 +7928,7 @@ Schema name: `RealtimeServerEventResponseAudioDelta` "(resource) realtime > (model) response_audio_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta", + "docstring": "Returned when the model-generated audio is updated.", "ident": "ResponseAudioDeltaEvent", "type": { "kind": "HttpTypeObject", @@ -7894,7 +7956,6 @@ Schema name: `RealtimeServerEventResponseAudioDelta` } ] }, - "docstring": "Returned when the model-generated audio is updated.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) content_index", @@ -7908,106 +7969,106 @@ Schema name: `RealtimeServerEventResponseAudioDelta` }, "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio data delta.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/delta", + "deprecated": false, "key": "delta", - "optional": false, - "nullable": false, + "docstring": "Base64-encoded audio data delta.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/delta", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_audio.delta`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_audio.delta`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_audio.delta" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDelta/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8052,6 +8113,7 @@ Schema name: `RealtimeServerEventResponseAudioDone` "(resource) realtime > (model) response_audio_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone", + "docstring": "Returned when the model-generated audio is done. Also emitted when a Response\nis interrupted, incomplete, or cancelled.\n", "ident": "ResponseAudioDoneEvent", "type": { "kind": "HttpTypeObject", @@ -8076,7 +8138,6 @@ Schema name: `RealtimeServerEventResponseAudioDone` } ] }, - "docstring": "Returned when the model-generated audio is done. Also emitted when a Response\nis interrupted, incomplete, or cancelled.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_audio_done_event > (schema) > (property) content_index", @@ -8089,92 +8150,92 @@ Schema name: `RealtimeServerEventResponseAudioDone` }, "(resource) realtime > (model) response_audio_done_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_done_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_audio.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_audio.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_audio.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8217,6 +8278,7 @@ Schema name: `RealtimeServerEventResponseAudioTranscriptDelta` "(resource) realtime > (model) response_audio_transcript_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta", + "docstring": "Returned when the model-generated transcription of audio output is updated.\n", "ident": "ResponseAudioTranscriptDeltaEvent", "type": { "kind": "HttpTypeObject", @@ -8244,7 +8306,6 @@ Schema name: `RealtimeServerEventResponseAudioTranscriptDelta` } ] }, - "docstring": "Returned when the model-generated transcription of audio output is updated.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) content_index", @@ -8258,106 +8319,106 @@ Schema name: `RealtimeServerEventResponseAudioTranscriptDelta` }, "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "The transcript delta.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/delta", + "deprecated": false, "key": "delta", - "optional": false, - "nullable": false, + "docstring": "The transcript delta.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/delta", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_audio_transcript.delta`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_audio_transcript.delta`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_audio_transcript.delta" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDelta/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8403,6 +8464,7 @@ Schema name: `RealtimeServerEventResponseAudioTranscriptDone` "(resource) realtime > (model) response_audio_transcript_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone", + "docstring": "Returned when the model-generated transcription of audio output is done\nstreaming. Also emitted when a Response is interrupted, incomplete, or\ncancelled.\n", "ident": "ResponseAudioTranscriptDoneEvent", "type": { "kind": "HttpTypeObject", @@ -8430,7 +8492,6 @@ Schema name: `RealtimeServerEventResponseAudioTranscriptDone` } ] }, - "docstring": "Returned when the model-generated transcription of audio output is done\nstreaming. Also emitted when a Response is interrupted, incomplete, or\ncancelled.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) content_index", @@ -8444,106 +8505,106 @@ Schema name: `RealtimeServerEventResponseAudioTranscriptDone` }, "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The final transcript of the audio.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": false, - "nullable": false, + "docstring": "The final transcript of the audio.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/transcript", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_audio_transcript_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_audio_transcript.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_audio_transcript.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_audio_transcript.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseAudioTranscriptDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8588,6 +8649,7 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` "(resource) realtime > (model) response_content_part_added_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded", + "docstring": "Returned when a new content part is added to an assistant message item during\nresponse generation.\n", "ident": "ResponseContentPartAddedEvent", "type": { "kind": "HttpTypeObject", @@ -8615,7 +8677,6 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` } ] }, - "docstring": "Returned when a new content part is added to an assistant message item during\nresponse generation.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) content_index", @@ -8629,66 +8690,66 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item to which the content part was added.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item to which the content part was added.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) part": { "kind": "HttpDeclProperty", - "docstring": "The content part that was added.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part", + "deprecated": false, "key": "part", - "optional": false, - "nullable": false, + "docstring": "The content part that was added.", "type": { "kind": "HttpTypeObject", "members": [ @@ -8706,8 +8767,8 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` } ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -8719,36 +8780,36 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.content_part.added`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.content_part.added`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.content_part.added" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8757,54 +8818,55 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) part > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio data (if type is \"audio\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio data (if type is \"audio\").", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) part > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (if type is \"text\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (if type is \"text\").", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) part > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio (if type is \"audio\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio (if type is \"audio\").", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_added_event > (schema) > (property) part > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (\"text\", \"audio\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (\"text\", \"audio\").", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -8814,11 +8876,10 @@ Schema name: `RealtimeServerEventResponseContentPartAdded` "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartAdded/properties/part/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -8881,6 +8942,7 @@ Schema name: `RealtimeServerEventResponseContentPartDone` "(resource) realtime > (model) response_content_part_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone", + "docstring": "Returned when a content part is done streaming in an assistant message item.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n", "ident": "ResponseContentPartDoneEvent", "type": { "kind": "HttpTypeObject", @@ -8908,7 +8970,6 @@ Schema name: `RealtimeServerEventResponseContentPartDone` } ] }, - "docstring": "Returned when a content part is done streaming in an assistant message item.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) content_index", @@ -8922,66 +8983,66 @@ Schema name: `RealtimeServerEventResponseContentPartDone` }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) part": { "kind": "HttpDeclProperty", - "docstring": "The content part that is done.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part", + "deprecated": false, "key": "part", - "optional": false, - "nullable": false, + "docstring": "The content part that is done.", "type": { "kind": "HttpTypeObject", "members": [ @@ -8999,8 +9060,8 @@ Schema name: `RealtimeServerEventResponseContentPartDone` } ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9012,36 +9073,36 @@ Schema name: `RealtimeServerEventResponseContentPartDone` }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.content_part.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.content_part.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.content_part.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9050,54 +9111,55 @@ Schema name: `RealtimeServerEventResponseContentPartDone` }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) part > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio data (if type is \"audio\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio data (if type is \"audio\").", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) part > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (if type is \"text\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (if type is \"text\").", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) part > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio (if type is \"audio\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio (if type is \"audio\").", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_content_part_done_event > (schema) > (property) part > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (\"text\", \"audio\").", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (\"text\", \"audio\").", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -9107,11 +9169,10 @@ Schema name: `RealtimeServerEventResponseContentPartDone` "kind": "HttpTypeLiteral", "literal": "text" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseContentPartDone/properties/part/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9174,6 +9235,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) response_created_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated", + "docstring": "Returned when a new Response is created. The first event of response creation,\nwhere the response is in an initial state of `in_progress`.\n", "ident": "ResponseCreatedEvent", "type": { "kind": "HttpTypeObject", @@ -9189,7 +9251,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "Returned when a new Response is created. The first event of response creation,\nwhere the response is in an initial state of `in_progress`.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_created_event > (schema) > (property) event_id", @@ -9199,33 +9260,33 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) response_created_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_created_event > (schema) > (property) response": { "kind": "HttpDeclProperty", - "docstring": "The response resource.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/response", + "deprecated": false, "key": "response", - "optional": false, - "nullable": false, + "docstring": "The response resource.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponse", "$ref": "(resource) realtime > (model) realtime_response > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/response", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response", "childrenParentSchema": "object", "children": [ @@ -9244,22 +9305,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) response_created_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.created`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.created`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.created" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseCreated/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9268,24 +9329,24 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the response, will look like `resp_1234`.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the response, will look like `resp_1234`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for audio output.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for audio output.", "type": { "kind": "HttpTypeObject", "members": [ @@ -9294,8 +9355,8 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9304,45 +9365,45 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) conversation_id": { "kind": "HttpDeclProperty", - "docstring": "Which conversation the response is added to, determined by the `conversation`\nfield in the `response.create` event. If `auto`, the response will be added to\nthe default conversation and the value of `conversation_id` will be an id like\n`conv_1234`. If `none`, the response will not be added to any conversation and\nthe value of `conversation_id` will be `null`. If responses are being triggered\nautomatically by VAD the response will be added to the default conversation\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/conversation_id", + "deprecated": false, "key": "conversation_id", - "optional": true, - "nullable": false, + "docstring": "Which conversation the response is added to, determined by the `conversation`\nfield in the `response.create` event. If `auto`, the response will be added to\nthe default conversation and the value of `conversation_id` will be an id like\n`conv_1234`. If `none`, the response will not be added to any conversation and\nthe value of `conversation_id` will be `null`. If responses are being triggered\nautomatically by VAD the response will be added to the default conversation\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/conversation_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response > (schema) > (property) max_output_tokens": { "kind": "HttpDeclProperty", - "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls, that was used in this response.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens", + "deprecated": false, "key": "max_output_tokens", - "optional": true, - "nullable": false, + "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls, that was used in this response.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens", "types": [ { "kind": "HttpTypeNumber" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -9352,40 +9413,40 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": true, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) realtime > (model) realtime_response > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, must be `realtime.response`.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "The object type, must be `realtime.response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.response" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9394,21 +9455,21 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The list of output items generated by the response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": false, + "docstring": "The list of output items generated by the response.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output", "elementType": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" + } }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output" - }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -9425,14 +9486,16 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) output_modalities": { "kind": "HttpDeclProperty", - "docstring": "The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities", + "deprecated": false, "key": "output_modalities", - "optional": true, - "nullable": false, + "docstring": "The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities/items", "types": [ { "kind": "HttpTypeLiteral", @@ -9442,13 +9505,11 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "audio" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities/items" - }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities" + ] + } }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -9458,12 +9519,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The final status of the response (`completed`, `cancelled`, `failed`, or \n`incomplete`, `in_progress`).\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The final status of the response (`completed`, `cancelled`, `failed`, or \n`incomplete`, `in_progress`).\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -9485,11 +9547,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -9502,19 +9563,19 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) status_details": { "kind": "HttpDeclProperty", - "docstring": "Additional details about the status.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details", + "deprecated": false, "key": "status_details", - "optional": true, - "nullable": false, + "docstring": "Additional details about the status.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseStatus", "$ref": "(resource) realtime > (model) realtime_response_status > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_status", "childrenParentSchema": "object", "children": [ @@ -9525,19 +9586,19 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage", + "deprecated": false, "key": "usage", - "optional": true, - "nullable": false, + "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseUsage", "$ref": "(resource) realtime > (model) realtime_response_usage > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_usage", "childrenParentSchema": "object", "children": [ @@ -9551,6 +9612,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse", + "docstring": "The response resource.", "ident": "RealtimeResponse", "type": { "kind": "HttpTypeObject", @@ -9590,7 +9652,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "The response resource.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response > (schema) > (property) id", @@ -9615,9 +9676,9 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -9629,8 +9690,8 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9653,13 +9714,13 @@ Schema name: `RealtimeServerEventResponseCreated` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -9669,9 +9730,11 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -9680,10 +9743,8 @@ Schema name: `RealtimeServerEventResponseCreated` { "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 > (schema) > (property) object > (member) 0": { @@ -9848,9 +9909,11 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -9897,10 +9960,8 @@ Schema name: `RealtimeServerEventResponseCreated` "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", @@ -9965,10 +10026,10 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "A description of the error that caused the response to fail, \npopulated when the `status` is `failed`.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": false, + "docstring": "A description of the error that caused the response to fail, \npopulated when the `status` is `failed`.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -9980,8 +10041,8 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -9991,12 +10052,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason the Response did not complete. For a `cancelled` Response, one of `turn_detected` (the server VAD detected a new start of speech) or `client_cancelled` (the client sent a cancel event). For an `incomplete` Response, one of `max_output_tokens` or `content_filter` (the server-side safety filter activated and cut off the response).\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason the Response did not complete. For a `cancelled` Response, one of `turn_detected` (the server VAD detected a new start of speech) or `client_cancelled` (the client sent a cancel event). For an `incomplete` Response, one of `max_output_tokens` or `content_filter` (the server-side safety filter activated and cut off the response).\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -10014,11 +10076,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "content_filter" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10030,12 +10091,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of error that caused the response to fail, corresponding \nwith the `status` field (`completed`, `cancelled`, `incomplete`, \n`failed`).\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of error that caused the response to fail, corresponding \nwith the `status` field (`completed`, `cancelled`, `incomplete`, \n`failed`).\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -10053,11 +10115,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "incomplete" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10070,6 +10131,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_response_status > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details", + "docstring": "Additional details about the status.", "ident": "RealtimeResponseStatus", "type": { "kind": "HttpTypeObject", @@ -10085,7 +10147,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "Additional details about the status.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_status > (schema) > (property) error", @@ -10095,19 +10156,19 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) input_token_details": { "kind": "HttpDeclProperty", - "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details", + "deprecated": false, "key": "input_token_details", - "optional": true, - "nullable": false, + "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseUsageInputTokenDetails", "$ref": "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_usage_input_token_details", "childrenParentSchema": "object", "children": [ @@ -10120,33 +10181,33 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of input tokens used in the Response, including text and \naudio tokens.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_tokens", + "deprecated": false, "key": "input_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of input tokens used in the Response, including text and \naudio tokens.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) output_token_details": { "kind": "HttpDeclProperty", - "docstring": "Details about the output tokens used in the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details", + "deprecated": false, "key": "output_token_details", - "optional": true, - "nullable": false, + "docstring": "Details about the output tokens used in the Response.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseUsageOutputTokenDetails", "$ref": "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_usage_output_token_details", "childrenParentSchema": "object", "children": [ @@ -10156,35 +10217,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of output tokens sent in the Response, including text and \naudio tokens.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_tokens", + "deprecated": false, "key": "output_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of output tokens sent in the Response, including text and \naudio tokens.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "The total number of tokens in the Response including input and output \ntext and audio tokens.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": true, - "nullable": false, + "docstring": "The total number of tokens in the Response including input and output \ntext and audio tokens.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/total_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/usage", + "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", "ident": "RealtimeResponseUsage", "type": { "kind": "HttpTypeObject", @@ -10206,7 +10268,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_usage > (schema) > (property) input_token_details", @@ -10218,19 +10279,19 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the output audio.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the output audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -10241,19 +10302,20 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) voice": { "kind": "HttpDeclProperty", - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice", + "deprecated": false, "key": "voice", - "optional": true, - "nullable": false, - "default": "alloy", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -10295,17 +10357,16 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice" + ] }, + "default": "alloy", "examples": [ "ash" ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -10322,12 +10383,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -10338,11 +10400,10 @@ Schema name: `RealtimeServerEventResponseCreated` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -10352,22 +10413,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10376,22 +10437,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10400,36 +10461,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10438,12 +10499,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -10457,11 +10519,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10473,6 +10534,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -10497,7 +10559,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "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", @@ -10510,12 +10571,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -10538,11 +10600,10 @@ Schema name: `RealtimeServerEventResponseCreated` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -10556,22 +10617,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10580,22 +10641,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10604,36 +10665,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10642,12 +10703,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -10661,11 +10723,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10677,6 +10738,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -10701,7 +10763,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -10714,12 +10775,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -10736,11 +10798,10 @@ Schema name: `RealtimeServerEventResponseCreated` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -10752,22 +10813,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10776,22 +10837,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10800,36 +10861,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10838,12 +10899,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -10857,11 +10919,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10873,6 +10934,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -10897,7 +10959,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -10910,50 +10971,50 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -10962,50 +11023,50 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11014,12 +11075,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -11033,11 +11095,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11049,6 +11110,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -11076,7 +11138,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -11090,50 +11151,50 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11142,36 +11203,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11180,12 +11241,13 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -11199,11 +11261,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11215,6 +11276,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -11239,7 +11301,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "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", @@ -11252,64 +11313,64 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11318,21 +11379,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -11354,7 +11416,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -11366,26 +11427,27 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -11402,11 +11464,10 @@ Schema name: `RealtimeServerEventResponseCreated` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -11418,22 +11479,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11442,21 +11503,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -11475,7 +11537,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "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", @@ -11486,78 +11547,78 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11566,26 +11627,27 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -11602,11 +11664,10 @@ Schema name: `RealtimeServerEventResponseCreated` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -11617,21 +11678,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -11662,7 +11724,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "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", @@ -11677,78 +11738,78 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -11758,6 +11819,7 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -11779,7 +11841,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "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", @@ -11791,29 +11852,29 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "Error code, if any.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/code", + "deprecated": false, "key": "code", - "optional": true, - "nullable": false, + "docstring": "Error code, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/code", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of error.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -11875,38 +11936,38 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) audio_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of audio tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/audio_tokens", + "deprecated": false, "key": "audio_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of audio tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/audio_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens", + "deprecated": false, "key": "cached_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details": { "kind": "HttpDeclProperty", - "docstring": "Details about the cached tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details", + "deprecated": false, "key": "cached_tokens_details", - "optional": true, - "nullable": false, + "docstring": "Details about the cached tokens used as input for the Response.", "type": { "kind": "HttpTypeObject", "members": [ @@ -11921,8 +11982,8 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -11933,35 +11994,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) image_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of image tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/image_tokens", + "deprecated": false, "key": "image_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of image tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/image_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) text_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of text tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/text_tokens", + "deprecated": false, "key": "text_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of text tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/text_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details", + "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", "ident": "RealtimeResponseUsageInputTokenDetails", "type": { "kind": "HttpTypeObject", @@ -11983,7 +12045,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) audio_tokens", @@ -11995,35 +12056,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema) > (property) audio_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of audio tokens used in the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/audio_tokens", + "deprecated": false, "key": "audio_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of audio tokens used in the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/audio_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema) > (property) text_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of text tokens used in the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/text_tokens", + "deprecated": false, "key": "text_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of text tokens used in the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/text_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details", + "docstring": "Details about the output tokens used in the Response.", "ident": "RealtimeResponseUsageOutputTokenDetails", "type": { "kind": "HttpTypeObject", @@ -12036,7 +12098,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "Details about the output tokens used in the Response.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema) > (property) audio_tokens", @@ -12046,7 +12107,8 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "PCMAudioFormat", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "ident": "PCMAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -12058,7 +12120,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "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", @@ -12068,7 +12129,8 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "PCMUAudioFormat", + "docstring": "The G.711 μ-law format.", + "ident": "PCMUAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -12077,7 +12139,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "The G.711 μ-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type" @@ -12086,7 +12147,8 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "PCMAAudioFormat", + "docstring": "The G.711 A-law format.", + "ident": "PCMAAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -12095,7 +12157,6 @@ Schema name: `RealtimeServerEventResponseCreated` } ] }, - "docstring": "The G.711 A-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type" @@ -12104,9 +12165,11 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_audio_formats > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "ident": "RealtimeAudioFormats", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats", "types": [ { "kind": "HttpTypeObject", @@ -12135,10 +12198,8 @@ Schema name: `RealtimeServerEventResponseCreated` } ] } - ], - "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", @@ -12158,9 +12219,11 @@ Schema name: `RealtimeServerEventResponseCreated` "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -12202,10 +12265,8 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0", @@ -12222,36 +12283,36 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12302,27 +12363,27 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -12336,11 +12397,11 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12351,57 +12412,58 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -12415,11 +12477,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12472,54 +12533,55 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -12529,11 +12591,10 @@ Schema name: `RealtimeServerEventResponseCreated` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12662,57 +12723,57 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -12851,64 +12912,64 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details > (property) audio_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached audio tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/audio_tokens", + "deprecated": false, "key": "audio_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached audio tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/audio_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details > (property) image_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached image tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/image_tokens", + "deprecated": false, "key": "image_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached image tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/image_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details > (property) text_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached text tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/text_tokens", + "deprecated": false, "key": "text_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached text tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/text_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { "kind": "HttpDeclProperty", - "docstring": "The sample rate of the audio. Always `24000`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", + "deprecated": false, "key": "rate", - "optional": true, - "nullable": false, + "docstring": "The sample rate of the audio. Always `24000`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", "types": [ { "kind": "HttpTypeLiteral", "literal": 24000 } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12917,22 +12978,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcm`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcm`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcm" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12941,22 +13002,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcmu`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcmu`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcmu" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -12965,22 +13026,22 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcma`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcma`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcma" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13122,47 +13183,47 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13171,34 +13232,34 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13207,47 +13268,47 @@ Schema name: `RealtimeServerEventResponseCreated` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13359,6 +13420,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) response_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseDone", + "docstring": "Returned when a Response is done streaming. Always emitted, no matter the \nfinal state. The Response object included in the `response.done` event will \ninclude all output Items in the Response but will omit the raw audio data.\n\nClients should check the `status` field of the Response to determine if it was successful\n(`completed`) or if there was another outcome: `cancelled`, `failed`, or `incomplete`.\n\nA response will contain all output items that were generated during the response, excluding\nany audio content.\n", "ident": "ResponseDoneEvent", "type": { "kind": "HttpTypeObject", @@ -13374,7 +13436,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "Returned when a Response is done streaming. Always emitted, no matter the \nfinal state. The Response object included in the `response.done` event will \ninclude all output Items in the Response but will omit the raw audio data.\n\nClients should check the `status` field of the Response to determine if it was successful\n(`completed`) or if there was another outcome: `cancelled`, `failed`, or `incomplete`.\n\nA response will contain all output items that were generated during the response, excluding\nany audio content.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_done_event > (schema) > (property) event_id", @@ -13384,33 +13445,33 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) response_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_done_event > (schema) > (property) response": { "kind": "HttpDeclProperty", - "docstring": "The response resource.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/response", + "deprecated": false, "key": "response", - "optional": false, - "nullable": false, + "docstring": "The response resource.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponse", "$ref": "(resource) realtime > (model) realtime_response > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/response", - "deprecated": false, - "schemaType": "object", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response", "childrenParentSchema": "object", "children": [ @@ -13429,22 +13490,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) response_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13453,24 +13514,24 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the response, will look like `resp_1234`.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the response, will look like `resp_1234`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for audio output.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for audio output.", "type": { "kind": "HttpTypeObject", "members": [ @@ -13479,8 +13540,8 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -13489,45 +13550,45 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) conversation_id": { "kind": "HttpDeclProperty", - "docstring": "Which conversation the response is added to, determined by the `conversation`\nfield in the `response.create` event. If `auto`, the response will be added to\nthe default conversation and the value of `conversation_id` will be an id like\n`conv_1234`. If `none`, the response will not be added to any conversation and\nthe value of `conversation_id` will be `null`. If responses are being triggered\nautomatically by VAD the response will be added to the default conversation\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/conversation_id", + "deprecated": false, "key": "conversation_id", - "optional": true, - "nullable": false, + "docstring": "Which conversation the response is added to, determined by the `conversation`\nfield in the `response.create` event. If `auto`, the response will be added to\nthe default conversation and the value of `conversation_id` will be an id like\n`conv_1234`. If `none`, the response will not be added to any conversation and\nthe value of `conversation_id` will be `null`. If responses are being triggered\nautomatically by VAD the response will be added to the default conversation\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/conversation_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response > (schema) > (property) max_output_tokens": { "kind": "HttpDeclProperty", - "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls, that was used in this response.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens", + "deprecated": false, "key": "max_output_tokens", - "optional": true, - "nullable": false, + "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls, that was used in this response.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens", "types": [ { "kind": "HttpTypeNumber" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -13537,40 +13598,40 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": true, - "nullable": true, + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "type": { "kind": "HttpTypeReference", "ident": "Metadata", "$ref": "(resource) $shared > (model) metadata > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/metadata", - "deprecated": false, - "schemaType": "map", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "map", "modelPath": "(resource) $shared > (model) metadata", "children": [] }, "(resource) realtime > (model) realtime_response > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type, must be `realtime.response`.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "The object type, must be `realtime.response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.response" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13579,21 +13640,21 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The list of output items generated by the response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": false, + "docstring": "The list of output items generated by the response.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output", "elementType": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" + } }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output" - }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -13610,14 +13671,16 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) output_modalities": { "kind": "HttpDeclProperty", - "docstring": "The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities", + "deprecated": false, "key": "output_modalities", - "optional": true, - "nullable": false, + "docstring": "The set of modalities the model used to respond, currently the only possible values are\n`[\\\"audio\\\"]`, `[\\\"text\\\"]`. Audio output always include a text transcript. Setting the\noutput to mode `text` will disable audio output from the model.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities/items", "types": [ { "kind": "HttpTypeLiteral", @@ -13627,13 +13690,11 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "audio" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities/items" - }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities" + ] + } }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/output_modalities", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -13643,12 +13704,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The final status of the response (`completed`, `cancelled`, `failed`, or \n`incomplete`, `in_progress`).\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The final status of the response (`completed`, `cancelled`, `failed`, or \n`incomplete`, `in_progress`).\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -13670,11 +13732,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -13687,19 +13748,19 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) status_details": { "kind": "HttpDeclProperty", - "docstring": "Additional details about the status.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details", + "deprecated": false, "key": "status_details", - "optional": true, - "nullable": false, + "docstring": "Additional details about the status.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseStatus", "$ref": "(resource) realtime > (model) realtime_response_status > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_status", "childrenParentSchema": "object", "children": [ @@ -13710,19 +13771,19 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) usage": { "kind": "HttpDeclProperty", - "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage", + "deprecated": false, "key": "usage", - "optional": true, - "nullable": false, + "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseUsage", "$ref": "(resource) realtime > (model) realtime_response_usage > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_usage", "childrenParentSchema": "object", "children": [ @@ -13736,6 +13797,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse", + "docstring": "The response resource.", "ident": "RealtimeResponse", "type": { "kind": "HttpTypeObject", @@ -13775,7 +13837,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "The response resource.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response > (schema) > (property) id", @@ -13800,9 +13861,9 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -13814,8 +13875,8 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -13838,13 +13899,13 @@ Schema name: `RealtimeServerEventResponseDone` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/max_output_tokens/oneOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -13854,9 +13915,11 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) $shared > (model) metadata > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Metadata", + "docstring": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\n\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.\n", "ident": "Metadata", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Metadata", "ident": "Record", "typeParameters": [ { @@ -13865,10 +13928,8 @@ Schema name: `RealtimeServerEventResponseDone` { "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 > (schema) > (property) object > (member) 0": { @@ -14033,9 +14094,11 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -14082,10 +14145,8 @@ Schema name: `RealtimeServerEventResponseDone` "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", @@ -14150,10 +14211,10 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "A description of the error that caused the response to fail, \npopulated when the `status` is `failed`.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": false, + "docstring": "A description of the error that caused the response to fail, \npopulated when the `status` is `failed`.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -14165,8 +14226,8 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -14176,12 +14237,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "The reason the Response did not complete. For a `cancelled` Response, one of `turn_detected` (the server VAD detected a new start of speech) or `client_cancelled` (the client sent a cancel event). For an `incomplete` Response, one of `max_output_tokens` or `content_filter` (the server-side safety filter activated and cut off the response).\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": false, + "docstring": "The reason the Response did not complete. For a `cancelled` Response, one of `turn_detected` (the server VAD detected a new start of speech) or `client_cancelled` (the client sent a cancel event). For an `incomplete` Response, one of `max_output_tokens` or `content_filter` (the server-side safety filter activated and cut off the response).\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason", "types": [ { "kind": "HttpTypeLiteral", @@ -14199,11 +14261,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "content_filter" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/reason", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14215,12 +14276,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of error that caused the response to fail, corresponding \nwith the `status` field (`completed`, `cancelled`, `incomplete`, \n`failed`).\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of error that caused the response to fail, corresponding \nwith the `status` field (`completed`, `cancelled`, `incomplete`, \n`failed`).\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -14238,11 +14300,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "incomplete" } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14255,6 +14316,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_response_status > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details", + "docstring": "Additional details about the status.", "ident": "RealtimeResponseStatus", "type": { "kind": "HttpTypeObject", @@ -14270,7 +14332,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "Additional details about the status.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_status > (schema) > (property) error", @@ -14280,19 +14341,19 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) input_token_details": { "kind": "HttpDeclProperty", - "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details", + "deprecated": false, "key": "input_token_details", - "optional": true, - "nullable": false, + "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseUsageInputTokenDetails", "$ref": "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_usage_input_token_details", "childrenParentSchema": "object", "children": [ @@ -14305,33 +14366,33 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) input_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of input tokens used in the Response, including text and \naudio tokens.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_tokens", + "deprecated": false, "key": "input_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of input tokens used in the Response, including text and \naudio tokens.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) output_token_details": { "kind": "HttpDeclProperty", - "docstring": "Details about the output tokens used in the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details", + "deprecated": false, "key": "output_token_details", - "optional": true, - "nullable": false, + "docstring": "Details about the output tokens used in the Response.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeResponseUsageOutputTokenDetails", "$ref": "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_response_usage_output_token_details", "childrenParentSchema": "object", "children": [ @@ -14341,35 +14402,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) output_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of output tokens sent in the Response, including text and \naudio tokens.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_tokens", + "deprecated": false, "key": "output_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of output tokens sent in the Response, including text and \naudio tokens.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage > (schema) > (property) total_tokens": { "kind": "HttpDeclProperty", - "docstring": "The total number of tokens in the Response including input and output \ntext and audio tokens.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/total_tokens", + "deprecated": false, "key": "total_tokens", - "optional": true, - "nullable": false, + "docstring": "The total number of tokens in the Response including input and output \ntext and audio tokens.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/total_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/usage", + "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", "ident": "RealtimeResponseUsage", "type": { "kind": "HttpTypeObject", @@ -14391,7 +14453,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "Usage statistics for the Response, this will correspond to billing. A \nRealtime API session will maintain a conversation context and append new \nItems to the Conversation, thus output from previous turns (text and \naudio tokens) will become the input for later turns.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_usage > (schema) > (property) input_token_details", @@ -14403,19 +14464,19 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the output audio.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the output audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -14426,19 +14487,20 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) voice": { "kind": "HttpDeclProperty", - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice", + "deprecated": false, "key": "voice", - "optional": true, - "nullable": false, - "default": "alloy", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -14480,17 +14542,16 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice" + ] }, + "default": "alloy", "examples": [ "ash" ], - "oasRef": "#/components/schemas/RealtimeResponse/properties/audio/properties/output/properties/voice", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -14507,12 +14568,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -14523,11 +14585,10 @@ Schema name: `RealtimeServerEventResponseDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -14537,22 +14598,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14561,22 +14622,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14585,36 +14646,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14623,12 +14684,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -14642,11 +14704,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14658,6 +14719,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -14682,7 +14744,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "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", @@ -14695,12 +14756,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -14723,11 +14785,10 @@ Schema name: `RealtimeServerEventResponseDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -14741,22 +14802,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14765,22 +14826,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14789,36 +14850,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14827,12 +14888,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -14846,11 +14908,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14862,6 +14923,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -14886,7 +14948,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -14899,12 +14960,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -14921,11 +14983,10 @@ Schema name: `RealtimeServerEventResponseDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -14937,22 +14998,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14961,22 +15022,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -14985,36 +15046,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15023,12 +15084,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -15042,11 +15104,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15058,6 +15119,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -15082,7 +15144,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -15095,50 +15156,50 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15147,50 +15208,50 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15199,12 +15260,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -15218,11 +15280,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15234,6 +15295,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -15261,7 +15323,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -15275,50 +15336,50 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15327,36 +15388,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15365,12 +15426,13 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -15384,11 +15446,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15400,6 +15461,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -15424,7 +15486,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "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", @@ -15437,64 +15498,64 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15503,21 +15564,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -15539,7 +15601,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -15551,26 +15612,27 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -15587,11 +15649,10 @@ Schema name: `RealtimeServerEventResponseDone` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -15603,22 +15664,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15627,21 +15688,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -15660,7 +15722,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "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", @@ -15671,78 +15732,78 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15751,26 +15812,27 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -15787,11 +15849,10 @@ Schema name: `RealtimeServerEventResponseDone` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -15802,21 +15863,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -15847,7 +15909,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "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", @@ -15862,78 +15923,78 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -15943,6 +16004,7 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -15964,7 +16026,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "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", @@ -15976,29 +16037,29 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) error > (property) code": { "kind": "HttpDeclProperty", - "docstring": "Error code, if any.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/code", + "deprecated": false, "key": "code", - "optional": true, - "nullable": false, + "docstring": "Error code, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/code", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_response_status > (schema) > (property) error > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of error.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of error.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/status_details/properties/error/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -16060,38 +16121,38 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) audio_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of audio tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/audio_tokens", + "deprecated": false, "key": "audio_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of audio tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/audio_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens", + "deprecated": false, "key": "cached_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details": { "kind": "HttpDeclProperty", - "docstring": "Details about the cached tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details", + "deprecated": false, "key": "cached_tokens_details", - "optional": true, - "nullable": false, + "docstring": "Details about the cached tokens used as input for the Response.", "type": { "kind": "HttpTypeObject", "members": [ @@ -16106,8 +16167,8 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -16118,35 +16179,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) image_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of image tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/image_tokens", + "deprecated": false, "key": "image_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of image tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/image_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) text_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of text tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/text_tokens", + "deprecated": false, "key": "text_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of text tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/text_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details", + "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", "ident": "RealtimeResponseUsageInputTokenDetails", "type": { "kind": "HttpTypeObject", @@ -16168,7 +16230,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "Details about the input tokens used in the Response. Cached tokens are tokens from previous turns in the conversation that are included as context for the current response. Cached tokens here are counted as a subset of input tokens, meaning input tokens will include cached and uncached tokens.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) audio_tokens", @@ -16180,35 +16241,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema) > (property) audio_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of audio tokens used in the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/audio_tokens", + "deprecated": false, "key": "audio_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of audio tokens used in the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/audio_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema) > (property) text_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of text tokens used in the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/text_tokens", + "deprecated": false, "key": "text_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of text tokens used in the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details/properties/text_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/output_token_details", + "docstring": "Details about the output tokens used in the Response.", "ident": "RealtimeResponseUsageOutputTokenDetails", "type": { "kind": "HttpTypeObject", @@ -16221,7 +16283,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "Details about the output tokens used in the Response.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_response_usage_output_token_details > (schema) > (property) audio_tokens", @@ -16231,7 +16292,8 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "PCMAudioFormat", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "ident": "PCMAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -16243,7 +16305,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "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", @@ -16253,7 +16314,8 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "PCMUAudioFormat", + "docstring": "The G.711 μ-law format.", + "ident": "PCMUAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -16262,7 +16324,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "The G.711 μ-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type" @@ -16271,7 +16332,8 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "PCMAAudioFormat", + "docstring": "The G.711 A-law format.", + "ident": "PCMAAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -16280,7 +16342,6 @@ Schema name: `RealtimeServerEventResponseDone` } ] }, - "docstring": "The G.711 A-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type" @@ -16289,9 +16350,11 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_audio_formats > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "ident": "RealtimeAudioFormats", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats", "types": [ { "kind": "HttpTypeObject", @@ -16320,10 +16383,8 @@ Schema name: `RealtimeServerEventResponseDone` } ] } - ], - "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", @@ -16343,9 +16404,11 @@ Schema name: `RealtimeServerEventResponseDone` "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -16387,10 +16450,8 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime > (model) realtime_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0", @@ -16407,36 +16468,36 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16487,27 +16548,27 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -16521,11 +16582,11 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16536,57 +16597,58 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -16600,11 +16662,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16657,54 +16718,55 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -16714,11 +16776,10 @@ Schema name: `RealtimeServerEventResponseDone` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -16847,57 +16908,57 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -17036,64 +17097,64 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details > (property) audio_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached audio tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/audio_tokens", + "deprecated": false, "key": "audio_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached audio tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/audio_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details > (property) image_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached image tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/image_tokens", + "deprecated": false, "key": "image_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached image tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/image_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_response_usage_input_token_details > (schema) > (property) cached_tokens_details > (property) text_tokens": { "kind": "HttpDeclProperty", - "docstring": "The number of cached text tokens used as input for the Response.", + "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/text_tokens", + "deprecated": false, "key": "text_tokens", - "optional": true, - "nullable": false, + "docstring": "The number of cached text tokens used as input for the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeResponse/properties/usage/properties/input_token_details/properties/cached_tokens_details/properties/text_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { "kind": "HttpDeclProperty", - "docstring": "The sample rate of the audio. Always `24000`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", + "deprecated": false, "key": "rate", - "optional": true, - "nullable": false, + "docstring": "The sample rate of the audio. Always `24000`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", "types": [ { "kind": "HttpTypeLiteral", "literal": 24000 } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17102,22 +17163,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcm`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcm`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcm" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17126,22 +17187,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcmu`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcmu`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcmu" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17150,22 +17211,22 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcma`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcma`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcma" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17307,47 +17368,47 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17356,34 +17417,34 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17392,47 +17453,47 @@ Schema name: `RealtimeServerEventResponseDone` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17568,6 +17629,7 @@ Schema name: `RealtimeServerEventResponseFunctionCallArgumentsDelta` "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta", + "docstring": "Returned when the model-generated function call arguments are updated.\n", "ident": "ResponseFunctionCallArgumentsDeltaEvent", "type": { "kind": "HttpTypeObject", @@ -17595,7 +17657,6 @@ Schema name: `RealtimeServerEventResponseFunctionCallArgumentsDelta` } ] }, - "docstring": "Returned when the model-generated function call arguments are updated.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) call_id", @@ -17609,106 +17670,106 @@ Schema name: `RealtimeServerEventResponseFunctionCallArgumentsDelta` }, "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "The arguments delta as a JSON string.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/delta", + "deprecated": false, "key": "delta", - "optional": false, - "nullable": false, + "docstring": "The arguments delta as a JSON string.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/delta", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.function_call_arguments.delta`.\n", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.function_call_arguments.delta`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.function_call_arguments.delta" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDelta/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17753,6 +17814,7 @@ Schema name: `RealtimeServerEventResponseFunctionCallArgumentsDone` "(resource) realtime > (model) response_function_call_arguments_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone", + "docstring": "Returned when the model-generated function call arguments are done streaming.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n", "ident": "ResponseFunctionCallArgumentsDoneEvent", "type": { "kind": "HttpTypeObject", @@ -17783,7 +17845,6 @@ Schema name: `RealtimeServerEventResponseFunctionCallArgumentsDone` } ] }, - "docstring": "Returned when the model-generated function call arguments are done streaming.\nAlso emitted when a Response is interrupted, incomplete, or cancelled.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) arguments", @@ -17798,120 +17859,120 @@ Schema name: `RealtimeServerEventResponseFunctionCallArgumentsDone` }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The final arguments as a JSON string.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The final arguments as a JSON string.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function that was called.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function that was called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_function_call_arguments_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.function_call_arguments.done`.\n", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.function_call_arguments.done`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.function_call_arguments.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseFunctionCallArgumentsDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -17956,6 +18017,7 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) response_output_item_added_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded", + "docstring": "Returned when a new Item is created during Response generation.", "ident": "ResponseOutputItemAddedEvent", "type": { "kind": "HttpTypeObject", @@ -17977,7 +18039,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "docstring": "Returned when a new Item is created during Response generation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_output_item_added_event > (schema) > (property) event_id", @@ -17989,33 +18050,33 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) response_output_item_added_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_output_item_added_event > (schema) > (property) item": { "kind": "HttpDeclProperty", - "docstring": "A single item within a Realtime conversation.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/item", + "deprecated": false, "key": "item", - "optional": false, - "nullable": false, + "docstring": "A single item within a Realtime conversation.", "type": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/item", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) conversation_item", "childrenParentSchema": "union", "children": [ @@ -18032,50 +18093,50 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) response_output_item_added_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the Response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_output_item_added_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the Response to which the item belongs.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the Response to which the item belongs.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_output_item_added_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_item.added`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_item.added`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_item.added" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemAdded/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18237,9 +18298,11 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -18286,10 +18349,8 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "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", @@ -18312,12 +18373,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -18328,11 +18390,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -18342,22 +18403,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18366,22 +18427,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18390,36 +18451,36 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18428,12 +18489,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -18447,11 +18509,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18463,6 +18524,7 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -18487,7 +18549,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "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", @@ -18500,12 +18561,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -18528,11 +18590,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -18546,22 +18607,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18570,22 +18631,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18594,36 +18655,36 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18632,12 +18693,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -18651,11 +18713,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18667,6 +18728,7 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -18691,7 +18753,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -18704,12 +18765,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -18726,11 +18788,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -18742,22 +18803,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18766,22 +18827,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18790,36 +18851,36 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18828,12 +18889,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -18847,11 +18909,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18863,6 +18924,7 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -18887,7 +18949,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -18900,50 +18961,50 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -18952,50 +19013,50 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19004,12 +19065,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -19023,11 +19085,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19039,6 +19100,7 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -19066,7 +19128,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -19080,50 +19141,50 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19132,36 +19193,36 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19170,12 +19231,13 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -19189,11 +19251,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19205,6 +19266,7 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -19229,7 +19291,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "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", @@ -19242,64 +19303,64 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19308,21 +19369,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -19344,7 +19406,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -19356,26 +19417,27 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -19392,11 +19454,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -19408,22 +19469,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19432,21 +19493,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -19465,7 +19527,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "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", @@ -19476,78 +19537,78 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19556,26 +19617,27 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -19592,11 +19654,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -19607,21 +19668,22 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -19652,7 +19714,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "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", @@ -19667,78 +19728,78 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19748,6 +19809,7 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -19769,7 +19831,6 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` } ] }, - "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", @@ -19781,36 +19842,36 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19861,27 +19922,27 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -19895,11 +19956,11 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -19910,57 +19971,58 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -19974,11 +20036,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20031,54 +20092,55 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -20088,11 +20150,10 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20221,57 +20282,57 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -20473,47 +20534,47 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20522,34 +20583,34 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20558,47 +20619,47 @@ Schema name: `RealtimeServerEventResponseOutputItemAdded` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20662,6 +20723,7 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) response_output_item_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone", + "docstring": "Returned when an Item is done streaming. Also emitted when a Response is \ninterrupted, incomplete, or cancelled.\n", "ident": "ResponseOutputItemDoneEvent", "type": { "kind": "HttpTypeObject", @@ -20683,7 +20745,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "docstring": "Returned when an Item is done streaming. Also emitted when a Response is \ninterrupted, incomplete, or cancelled.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_output_item_done_event > (schema) > (property) event_id", @@ -20695,33 +20756,33 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) response_output_item_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_output_item_done_event > (schema) > (property) item": { "kind": "HttpDeclProperty", - "docstring": "A single item within a Realtime conversation.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/item", + "deprecated": false, "key": "item", - "optional": false, - "nullable": false, + "docstring": "A single item within a Realtime conversation.", "type": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/item", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) conversation_item", "childrenParentSchema": "union", "children": [ @@ -20738,50 +20799,50 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) response_output_item_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the Response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the Response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_output_item_done_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the Response to which the item belongs.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the Response to which the item belongs.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_output_item_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_item.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_item.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_item.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseOutputItemDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -20943,9 +21004,11 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -20992,10 +21055,8 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "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", @@ -21018,12 +21079,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -21034,11 +21096,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -21048,22 +21109,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21072,22 +21133,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21096,36 +21157,36 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21134,12 +21195,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -21153,11 +21215,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21169,6 +21230,7 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -21193,7 +21255,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "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", @@ -21206,12 +21267,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -21234,11 +21296,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -21252,22 +21313,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21276,22 +21337,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21300,36 +21361,36 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21338,12 +21399,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -21357,11 +21419,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21373,6 +21434,7 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -21397,7 +21459,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -21410,12 +21471,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -21432,11 +21494,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -21448,22 +21509,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21472,22 +21533,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21496,36 +21557,36 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21534,12 +21595,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -21553,11 +21615,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21569,6 +21630,7 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -21593,7 +21655,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -21606,50 +21667,50 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21658,50 +21719,50 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21710,12 +21771,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -21729,11 +21791,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21745,6 +21806,7 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -21772,7 +21834,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -21786,50 +21847,50 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21838,36 +21899,36 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21876,12 +21937,13 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -21895,11 +21957,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -21911,6 +21972,7 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -21935,7 +21997,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "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", @@ -21948,64 +22009,64 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22014,21 +22075,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -22050,7 +22112,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -22062,26 +22123,27 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -22098,11 +22160,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -22114,22 +22175,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22138,21 +22199,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -22171,7 +22233,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "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", @@ -22182,78 +22243,78 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22262,26 +22323,27 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -22298,11 +22360,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -22313,21 +22374,22 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -22358,7 +22420,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "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", @@ -22373,78 +22434,78 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22454,6 +22515,7 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -22475,7 +22537,6 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` } ] }, - "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", @@ -22487,36 +22548,36 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22567,27 +22628,27 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -22601,11 +22662,11 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22616,57 +22677,58 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -22680,11 +22742,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22737,54 +22798,55 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -22794,11 +22856,10 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -22927,57 +22988,57 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -23179,47 +23240,47 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23228,34 +23289,34 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23264,47 +23325,47 @@ Schema name: `RealtimeServerEventResponseOutputItemDone` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23372,6 +23433,7 @@ Schema name: `RealtimeServerEventResponseTextDelta` "(resource) realtime > (model) response_text_delta_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta", + "docstring": "Returned when the text value of an \"output_text\" content part is updated.", "ident": "ResponseTextDeltaEvent", "type": { "kind": "HttpTypeObject", @@ -23399,7 +23461,6 @@ Schema name: `RealtimeServerEventResponseTextDelta` } ] }, - "docstring": "Returned when the text value of an \"output_text\" content part is updated.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_text_delta_event > (schema) > (property) content_index", @@ -23413,106 +23474,106 @@ Schema name: `RealtimeServerEventResponseTextDelta` }, "(resource) realtime > (model) response_text_delta_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_text_delta_event > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "The text delta.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/delta", + "deprecated": false, "key": "delta", - "optional": false, - "nullable": false, + "docstring": "The text delta.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/delta", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_delta_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_delta_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_delta_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_text_delta_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_delta_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_text.delta`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_text.delta`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_text.delta" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDelta/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23557,6 +23618,7 @@ Schema name: `RealtimeServerEventResponseTextDone` "(resource) realtime > (model) response_text_done_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone", + "docstring": "Returned when the text value of an \"output_text\" content part is done streaming. Also\nemitted when a Response is interrupted, incomplete, or cancelled.\n", "ident": "ResponseTextDoneEvent", "type": { "kind": "HttpTypeObject", @@ -23584,7 +23646,6 @@ Schema name: `RealtimeServerEventResponseTextDone` } ] }, - "docstring": "Returned when the text value of an \"output_text\" content part is done streaming. Also\nemitted when a Response is interrupted, incomplete, or cancelled.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_text_done_event > (schema) > (property) content_index", @@ -23598,106 +23659,106 @@ Schema name: `RealtimeServerEventResponseTextDone` }, "(resource) realtime > (model) response_text_done_event > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the content part in the item's content array.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the content part in the item's content array.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_text_done_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_done_event > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_done_event > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_text_done_event > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_done_event > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The final text content.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The final text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_text_done_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.output_text.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.output_text.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.output_text.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseTextDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23743,6 +23804,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) session_created_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated", + "docstring": "Returned when a Session is created. Emitted automatically when a new\nconnection is established as the first server event. This event will contain\nthe default Session configuration.\n", "ident": "SessionCreatedEvent", "type": { "kind": "HttpTypeObject", @@ -23758,7 +23820,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Returned when a Session is created. Emitted automatically when a new\nconnection is established as the first server event. This event will contain\nthe default Session configuration.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) session_created_event > (schema) > (property) event_id", @@ -23768,26 +23829,27 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) session_created_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) session_created_event > (schema) > (property) session": { "kind": "HttpDeclProperty", - "docstring": "The session configuration.", + "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/session", + "deprecated": false, "key": "session", - "optional": false, - "nullable": false, + "docstring": "The session configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/session", "types": [ { "kind": "HttpTypeReference", @@ -23799,11 +23861,10 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "RealtimeTranscriptionSessionCreateResponse", "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/session" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/session", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -23813,22 +23874,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) session_created_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `session.created`.", + "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `session.created`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "session.created" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventSessionCreated/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -23882,6 +23943,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA", + "docstring": "A Realtime session configuration object.\n", "ident": "RealtimeSessionCreateResponse", "type": { "kind": "HttpTypeObject", @@ -23936,7 +23998,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "A Realtime session configuration object.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id", @@ -23960,6 +24021,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA", + "docstring": "A Realtime transcription session configuration object.\n", "ident": "RealtimeTranscriptionSessionCreateResponse", "type": { "kind": "HttpTypeObject", @@ -23984,7 +24046,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "A Realtime transcription session configuration object.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id", @@ -24004,36 +24065,36 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type. Always `realtime.session`.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type. Always `realtime.session`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.session" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24042,22 +24103,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24066,10 +24127,10 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for input and output audio.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -24081,8 +24142,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -24092,43 +24153,43 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": true, - "nullable": false, + "docstring": "Expiration timestamp for the session, in seconds since epoch.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/expires_at", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include": { "kind": "HttpDeclProperty", - "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", + "deprecated": false, "key": "include", - "optional": true, - "nullable": false, + "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include/items", "types": [ { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -24137,45 +24198,45 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": true, - "nullable": false, + "docstring": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/instructions", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens": { "kind": "HttpDeclProperty", - "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", + "deprecated": false, "key": "max_output_tokens", - "optional": true, - "nullable": false, + "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", "types": [ { "kind": "HttpTypeNumber" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -24185,18 +24246,20 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The Realtime model used for this session.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The Realtime model used for this session.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -24274,14 +24337,12 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-12-15" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -24291,17 +24352,16 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities": { "kind": "HttpDeclProperty", - "docstring": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", + "deprecated": false, "key": "output_modalities", - "optional": true, - "nullable": false, - "default": [ - "audio" - ], + "docstring": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities/items", "types": [ { "kind": "HttpTypeLiteral", @@ -24311,13 +24371,14 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "audio" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", - "deprecated": false, + "default": [ + "audio" + ], + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -24327,19 +24388,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": true, + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "type": { "kind": "HttpTypeReference", "ident": "ResponsePrompt", "$ref": "(resource) responses > (model) response_prompt > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/prompt", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) responses > (model) response_prompt", "childrenParentSchema": "object", "children": [ @@ -24350,20 +24411,20 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning": { "kind": "HttpDeclProperty", - "title": "Realtime reasoning configuration", - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/reasoning", + "deprecated": false, "key": "reasoning", - "optional": true, - "nullable": false, + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "title": "Realtime reasoning configuration", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoning", "$ref": "(resource) realtime > (model) realtime_reasoning > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/reasoning", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_reasoning", "childrenParentSchema": "object", "children": [ @@ -24372,13 +24433,13 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", "types": [ { "kind": "HttpTypeReference", @@ -24395,11 +24456,11 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "ToolChoiceMcp", "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -24410,14 +24471,16 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "Tools available to the model.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "Tools available to the model.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -24465,13 +24528,11 @@ Schema name: `RealtimeServerEventSessionCreated` } ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -24481,23 +24542,24 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing": { "kind": "HttpDeclProperty", - "title": "Tracing Configuration", - "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", + "deprecated": false, "key": "tracing", - "optional": true, - "nullable": true, + "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", + "title": "Tracing Configuration", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" + ] }, { "kind": "HttpTypeObject", @@ -24513,11 +24575,10 @@ Schema name: `RealtimeServerEventSessionCreated` } ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -24527,20 +24588,20 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation": { "kind": "HttpDeclProperty", - "title": "Realtime Truncation Controls", - "docstring": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/truncation", + "deprecated": false, "key": "truncation", - "optional": true, - "nullable": false, + "docstring": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.\n", + "title": "Realtime Truncation Controls", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTruncation", "$ref": "(resource) realtime > (model) realtime_truncation > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/truncation", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_truncation", "childrenParentSchema": "union", "children": [ @@ -24550,50 +24611,50 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type. Always `realtime.transcription_session`.", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type. Always `realtime.transcription_session`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of session. Always `transcription` for transcription sessions.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of session. Always `transcription` for transcription sessions.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "transcription" } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -24602,10 +24663,10 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio for the session.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio for the session.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -24614,8 +24675,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -24624,43 +24685,43 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": true, - "nullable": false, + "docstring": "Expiration timestamp for the session, in seconds since epoch.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/expires_at", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include": { "kind": "HttpDeclProperty", - "docstring": "Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", + "deprecated": false, "key": "include", - "optional": true, - "nullable": false, + "docstring": "Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include/items", "types": [ { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include/items" - }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include" + ] + } }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -24683,9 +24744,9 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input", + "deprecated": false, "key": "input", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -24703,8 +24764,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -24716,9 +24777,9 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -24733,8 +24794,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -24765,13 +24826,13 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -24790,9 +24851,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", + "docstring": "The Realtime model used for this session.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -24870,10 +24933,8 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-12-15" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" + ] }, - "docstring": "The Realtime model used for this session.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 0", @@ -24913,27 +24974,28 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_prompt > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique identifier of the prompt template to use.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique identifier of the prompt template to use.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema) > (property) variables": { "kind": "HttpDeclProperty", - "title": "Prompt Variables", - "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", + "deprecated": false, "key": "variables", - "optional": true, - "nullable": true, + "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "title": "Prompt Variables", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", "ident": "Record", "typeParameters": [ { @@ -24941,6 +25003,7 @@ Schema name: `RealtimeServerEventSessionCreated` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties", "types": [ { "kind": "HttpTypeString" @@ -24960,14 +25023,12 @@ Schema name: `RealtimeServerEventSessionCreated` "ident": "ResponseInputFile", "$ref": "(resource) responses > (model) response_input_file > (schema)" } - ], - "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties" + ] } - ], - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables" + ] }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "childrenParentSchema": "union", "children": [ @@ -24979,21 +25040,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_prompt > (schema) > (property) version": { "kind": "HttpDeclProperty", - "docstring": "Optional version of the prompt template.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", + "deprecated": false, "key": "version", - "optional": true, - "nullable": true, + "docstring": "Optional version of the prompt template.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Prompt", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "ident": "ResponsePrompt", "type": { "kind": "HttpTypeObject", @@ -25009,7 +25071,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "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", @@ -25019,20 +25080,20 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", - "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", + "deprecated": false, "key": "effort", - "optional": true, - "nullable": false, - "default": "low", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoningEffort", "$ref": "(resource) realtime > (model) realtime_reasoning_effort > (schema)" }, - "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", - "deprecated": false, - "schemaType": "enum", + "default": "low", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) realtime_reasoning_effort", "childrenParentSchema": "enum", "children": [ @@ -25046,6 +25107,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoning", + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "ident": "RealtimeReasoning", "type": { "kind": "HttpTypeObject", @@ -25055,7 +25117,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" @@ -25105,9 +25166,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) tool_choice_options > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceOptions", + "docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n", "ident": "ToolChoiceOptions", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceOptions", "types": [ { "kind": "HttpTypeLiteral", @@ -25121,10 +25184,8 @@ Schema name: `RealtimeServerEventSessionCreated` "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", @@ -25135,6 +25196,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) tool_choice_function > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceFunction", + "docstring": "Use this option to force the model to call a specific function.\n", "ident": "ToolChoiceFunction", "type": { "kind": "HttpTypeObject", @@ -25147,7 +25209,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "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", @@ -25157,6 +25218,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) tool_choice_mcp > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceMCP", + "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", "ident": "ToolChoiceMcp", "type": { "kind": "HttpTypeObject", @@ -25172,7 +25234,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "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", @@ -25198,6 +25259,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items/oneOf/1", + "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n", "ident": "McpTool", "type": { "kind": "HttpTypeObject", @@ -25240,7 +25302,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "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.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label", @@ -25289,18 +25350,18 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", + "docstring": "Enables tracing and sets default values for tracing configuration options. Always `auto`.\n", "ident": "Auto", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" + ] }, - "docstring": "Enables tracing and sets default values for tracing configuration options. Always `auto`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0 > (member) 0" @@ -25309,6 +25370,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1", + "docstring": "Granular configuration for tracing.\n", "ident": "TracingConfiguration", "type": { "kind": "HttpTypeObject", @@ -25324,7 +25386,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Granular configuration for tracing.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id", @@ -25335,9 +25396,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", + "docstring": "The truncation strategy to use for the session. `auto` is the default truncation strategy. `disabled` will disable truncation and emit errors when the conversation exceeds the input token limit.", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -25347,10 +25410,8 @@ Schema name: `RealtimeServerEventSessionCreated` "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", @@ -25360,6 +25421,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1", + "docstring": "Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.", "ident": "RetentionRatioTruncation", "type": { "kind": "HttpTypeObject", @@ -25375,7 +25437,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "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", @@ -25386,12 +25447,15 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_truncation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation", + "docstring": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.\n", "ident": "RealtimeTruncation", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -25401,8 +25465,7 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "disabled" } - ], - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0" + ] }, { "kind": "HttpTypeObject", @@ -25418,10 +25481,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] } - ], - "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", @@ -25437,9 +25498,9 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input", + "deprecated": false, "key": "input", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -25457,8 +25518,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -25477,19 +25538,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the input audio.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the input audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -25500,10 +25561,10 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", + "deprecated": false, "key": "noise_reduction", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -25512,8 +25573,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -25522,16 +25583,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", + "deprecated": false, "key": "transcription", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "language" }, + { + "ident": "languages" + }, { "ident": "model" }, @@ -25540,25 +25604,27 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", - "title": "Realtime Turn Detection", - "docstring": "Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\n\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\n\nSemantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, "key": "turn_detection", - "optional": true, - "nullable": true, + "docstring": "Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\n\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\n\nSemantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", + "title": "Realtime Turn Detection", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", "types": [ { "kind": "HttpTypeObject", @@ -25603,11 +25669,10 @@ Schema name: `RealtimeServerEventSessionCreated` } ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -25617,19 +25682,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the output audio.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the output audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -25640,38 +25705,39 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) speed": { "kind": "HttpDeclProperty", - "docstring": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/speed", + "deprecated": false, "key": "speed", - "optional": true, - "nullable": false, - "default": 1, + "docstring": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { - "maximum": 1.5, - "minimum": 0.25 + "minimum": 0.25, + "maximum": 1.5 }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/speed", - "deprecated": false, + "default": 1, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice": { "kind": "HttpDeclProperty", - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", + "deprecated": false, "key": "voice", - "optional": true, - "nullable": false, - "default": "alloy", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -25713,17 +25779,16 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice" + ] }, + "default": "alloy", "examples": [ "ash" ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -25931,6 +25996,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) response_input_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputTextContent", + "docstring": "A text input to the model.", "ident": "ResponseInputText", "type": { "kind": "HttpTypeObject", @@ -25946,7 +26012,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "A text input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_text > (schema) > (property) text", @@ -25957,6 +26022,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) response_input_image > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputImageContent", + "docstring": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "ident": "ResponseInputImage", "type": { "kind": "HttpTypeObject", @@ -25978,7 +26044,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "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", @@ -25991,6 +26056,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) responses > (model) response_input_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputFileContent", + "docstring": "A file input to the model.", "ident": "ResponseInputFile", "type": { "kind": "HttpTypeObject", @@ -26018,7 +26084,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "A file input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_file > (schema) > (property) type", @@ -26068,9 +26133,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_reasoning_effort > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoningEffort", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "ident": "RealtimeReasoningEffort", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeReasoningEffort", "types": [ { "kind": "HttpTypeLiteral", @@ -26092,10 +26159,8 @@ Schema name: `RealtimeServerEventSessionCreated` "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", @@ -26128,36 +26193,36 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_function > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For function calling, the type is always `function`.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For function calling, the type is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26166,36 +26231,36 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server to use.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server to use.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For MCP tools, the type is always `mcp`.", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For MCP tools, the type is always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26204,78 +26269,78 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to call on the server.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": true, + "docstring": "The name of the tool to call on the server.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "Parameters of the function in JSON Schema.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "docstring": "Parameters of the function in JSON Schema.", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool, i.e. `function`.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the tool, i.e. `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26284,36 +26349,36 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "A label for this MCP server, used to identify it in tool calls.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "A label for this MCP server, used to identify it in tool calls.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the MCP tool. Always `mcp`.", + "oasRef": "#/components/schemas/MCPTool/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the MCP tool. Always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/type" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26322,14 +26387,16 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers": { "kind": "HttpDeclProperty", - "docstring": "The tool invocation context(s).", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", + "deprecated": false, "key": "allowed_callers", - "optional": true, - "nullable": true, + "docstring": "The tool invocation context(s).", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items", "types": [ { "kind": "HttpTypeLiteral", @@ -26339,13 +26406,11 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "programmatic" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers" + ] + } }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -26355,19 +26420,20 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools": { "kind": "HttpDeclProperty", - "docstring": "List of allowed tool names or a filter object.\n", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", + "deprecated": false, "key": "allowed_tools", - "optional": true, - "nullable": true, + "docstring": "List of allowed tool names or a filter object.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", "types": [ { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" + } }, { "kind": "HttpTypeObject", @@ -26380,11 +26446,10 @@ Schema name: `RealtimeServerEventSessionCreated` } ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -26394,26 +26459,27 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) authorization": { "kind": "HttpDeclProperty", - "docstring": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n", + "oasRef": "#/components/schemas/MCPTool/properties/authorization", + "deprecated": false, "key": "authorization", - "optional": true, - "nullable": false, + "docstring": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/authorization", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id": { "kind": "HttpDeclProperty", - "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", + "deprecated": false, "key": "connector_id", - "optional": true, - "nullable": false, + "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", "types": [ { "kind": "HttpTypeLiteral", @@ -26447,11 +26513,10 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "connector_sharepoint" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/connector_id" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/connector_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26467,26 +26532,27 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading": { "kind": "HttpDeclProperty", - "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", + "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", + "deprecated": false, "key": "defer_loading", - "optional": true, - "nullable": false, + "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) headers": { "kind": "HttpDeclProperty", - "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", + "oasRef": "#/components/schemas/MCPTool/properties/headers", + "deprecated": false, "key": "headers", - "optional": true, - "nullable": true, + "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/MCPTool/properties/headers", "ident": "Record", "typeParameters": [ { @@ -26495,23 +26561,22 @@ Schema name: `RealtimeServerEventSessionCreated` { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/headers" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/headers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval": { "kind": "HttpDeclProperty", - "docstring": "Specify which of the MCP server's tools require approval.", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", + "deprecated": false, "key": "require_approval", - "optional": true, - "nullable": true, - "default": "always", + "docstring": "Specify which of the MCP server's tools require approval.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", "types": [ { "kind": "HttpTypeObject", @@ -26526,6 +26591,7 @@ Schema name: `RealtimeServerEventSessionCreated` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -26535,14 +26601,13 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "never" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval", - "deprecated": false, + "default": "always", + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -26552,46 +26617,46 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description": { "kind": "HttpDeclProperty", - "docstring": "Optional description of the MCP server, used to provide more context.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_description", + "deprecated": false, "key": "server_description", - "optional": true, - "nullable": false, + "docstring": "Optional description of the MCP server, used to provide more context.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_url": { "kind": "HttpDeclProperty", - "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_url", + "deprecated": false, "key": "server_url", - "optional": true, - "nullable": false, + "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) tunnel_id": { "kind": "HttpDeclProperty", - "docstring": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.\n", + "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", + "deprecated": false, "key": "tunnel_id", - "optional": true, - "nullable": false, + "docstring": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -26604,43 +26669,43 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id": { "kind": "HttpDeclProperty", - "docstring": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/group_id", + "deprecated": false, "key": "group_id", - "optional": true, - "nullable": false, + "docstring": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/group_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": true, - "nullable": false, + "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/metadata", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) workflow_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/workflow_name", + "deprecated": false, "key": "workflow_name", - "optional": true, - "nullable": false, + "docstring": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/workflow_name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -26660,10 +26725,10 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio": { "kind": "HttpDeclProperty", - "docstring": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.\n", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", + "deprecated": false, "key": "retention_ratio", - "optional": false, - "nullable": false, + "docstring": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.\n", "type": { "kind": "HttpTypeNumber" }, @@ -26671,29 +26736,29 @@ Schema name: `RealtimeServerEventSessionCreated` "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Use retention ratio truncation.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Use retention ratio truncation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "retention_ratio" } - ], - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -26702,10 +26767,10 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits": { "kind": "HttpDeclProperty", - "docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", + "deprecated": false, "key": "token_limits", - "optional": true, - "nullable": false, + "docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.", "type": { "kind": "HttpTypeObject", "members": [ @@ -26714,8 +26779,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -26724,19 +26789,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -26747,10 +26812,10 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio noise reduction.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", + "deprecated": false, "key": "noise_reduction", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio noise reduction.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -26759,8 +26824,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -26769,16 +26834,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "Configuration of the transcription model.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", + "deprecated": false, "key": "transcription", - "optional": true, - "nullable": false, + "docstring": "Configuration of the transcription model.\n", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "language" }, + { + "ident": "languages" + }, { "ident": "model" }, @@ -26787,31 +26855,32 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", - "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, "key": "turn_detection", - "optional": true, - "nullable": true, + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTranscriptionSessionTurnDetection", "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection", "childrenParentSchema": "object", "children": [ @@ -26824,7 +26893,8 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "PCMAudioFormat", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "ident": "PCMAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -26836,7 +26906,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "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", @@ -26846,7 +26915,8 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "PCMUAudioFormat", + "docstring": "The G.711 μ-law format.", + "ident": "PCMUAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -26855,7 +26925,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "The G.711 μ-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type" @@ -26864,7 +26933,8 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "PCMAAudioFormat", + "docstring": "The G.711 A-law format.", + "ident": "PCMAAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -26873,7 +26943,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "The G.711 A-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type" @@ -26882,9 +26951,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) realtime_audio_formats > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "ident": "RealtimeAudioFormats", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats", "types": [ { "kind": "HttpTypeObject", @@ -26913,10 +26984,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] } - ], - "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", @@ -26926,19 +26995,19 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", "type": { "kind": "HttpTypeReference", "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", - "deprecated": false, - "schemaType": "enum", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) noise_reduction_type", "childrenParentSchema": "enum", "children": [ @@ -26948,37 +27017,65 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { "kind": "HttpDeclProperty", - "docstring": "The language of the input audio.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", + "deprecated": false, "key": "language", + "docstring": "The language of the input audio.\n", + "type": { + "kind": "HttpTypeString" + }, "optional": true, "nullable": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages": { + "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "deprecated": false, + "key": "languages", + "docstring": "The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n", "type": { + "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", - "deprecated": false, - "schemaType": "string", + "optional": true, + "nullable": false, + "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -26999,14 +27096,12 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" + ] }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -27016,21 +27111,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "The prompt configured for input audio transcription, when present.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": false, + "docstring": "The prompt configured for input audio transcription, when present.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0", + "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "ident": "ServerVad", "type": { "kind": "HttpTypeObject", @@ -27058,7 +27154,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type", @@ -27073,6 +27168,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1", + "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "ident": "SemanticVad", "type": { "kind": "HttpTypeObject", @@ -27091,7 +27187,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type", @@ -27112,9 +27207,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -27156,10 +27253,8 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0", @@ -27176,37 +27271,37 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_text > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text input to the model.", + "oasRef": "#/components/schemas/InputTextContent/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text input to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputTextContent/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_text`.", + "oasRef": "#/components/schemas/InputTextContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_text", + "docstring": "The type of the input item. Always `input_text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputTextContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/InputTextContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/type", - "deprecated": false, + "default": "input_text", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27215,11 +27310,11 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -27228,8 +27323,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27238,12 +27333,13 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_image > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": false, - "nullable": false, + "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -27261,11 +27357,10 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "original" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/detail", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27277,23 +27372,23 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_image > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_image`.", + "oasRef": "#/components/schemas/InputImageContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_image", + "docstring": "The type of the input item. Always `input_image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/type", - "deprecated": false, + "default": "input_image", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27302,42 +27397,42 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_image > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputImageContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputImageContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", + "oasRef": "#/components/schemas/InputImageContent/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": true, + "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputImageContent/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -27346,8 +27441,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27356,23 +27451,23 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_file > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_file`.", + "oasRef": "#/components/schemas/InputFileContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_file", + "docstring": "The type of the input item. Always `input_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_file" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/type", - "deprecated": false, + "default": "input_file", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27381,12 +27476,13 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, + "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -27400,11 +27496,10 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/detail", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27415,70 +27510,70 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_file > (schema) > (property) file_data": { "kind": "HttpDeclProperty", - "docstring": "The content of the file to be sent to the model.\n", + "oasRef": "#/components/schemas/InputFileContent/properties/file_data", + "deprecated": false, "key": "file_data", - "optional": true, - "nullable": false, + "docstring": "The content of the file to be sent to the model.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_data", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_url", + "deprecated": false, "key": "file_url", - "optional": true, - "nullable": false, + "docstring": "The URL of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) filename": { "kind": "HttpDeclProperty", - "docstring": "The name of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/filename", + "deprecated": false, "key": "filename", - "optional": true, - "nullable": false, + "docstring": "The name of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/filename", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -27487,8 +27582,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -27540,20 +27635,21 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", + "docstring": "A string array of allowed tool names", "ident": "McpAllowedTools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" - }, - "docstring": "A string array of allowed tool names", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/1", + "docstring": "A filter object to specify which tools are allowed.\n", "ident": "McpToolFilter", "type": { "kind": "HttpTypeObject", @@ -27566,7 +27662,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "A filter object to specify which tools are allowed.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only", @@ -27632,6 +27727,7 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0", + "docstring": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n", "ident": "McpToolApprovalFilter", "type": { "kind": "HttpTypeObject", @@ -27644,7 +27740,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always", @@ -27654,9 +27749,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", + "docstring": "Specify a single approval policy for all tools. One of `always` or\n`never`. When set to `always`, all tools will require approval. When\nset to `never`, all tools will not require approval.\n", "ident": "McpToolApprovalSetting", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -27666,10 +27763,8 @@ Schema name: `RealtimeServerEventSessionCreated` "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.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0", @@ -27685,36 +27780,36 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions": { "kind": "HttpDeclProperty", - "docstring": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", + "deprecated": false, "key": "post_instructions", - "optional": true, - "nullable": false, + "docstring": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", "type": { "kind": "HttpTypeReference", "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", - "deprecated": false, - "schemaType": "enum", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) noise_reduction_type", "childrenParentSchema": "enum", "children": [ @@ -27724,37 +27819,65 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { "kind": "HttpDeclProperty", - "docstring": "The language of the input audio.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", + "deprecated": false, "key": "language", + "docstring": "The language of the input audio.\n", + "type": { + "kind": "HttpTypeString" + }, "optional": true, "nullable": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages": { + "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "deprecated": false, + "key": "languages", + "docstring": "The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n", "type": { + "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", - "deprecated": false, - "schemaType": "string", + "optional": true, + "nullable": false, + "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -27775,14 +27898,12 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" + ] }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -27792,77 +27913,78 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "The prompt configured for input audio transcription, when present.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": false, + "docstring": "The prompt configured for input audio transcription, when present.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms": { "kind": "HttpDeclProperty", - "docstring": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/prefix_padding_ms", + "deprecated": false, "key": "prefix_padding_ms", - "optional": true, - "nullable": false, + "docstring": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/prefix_padding_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms": { "kind": "HttpDeclProperty", - "docstring": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/silence_duration_ms", + "deprecated": false, "key": "silence_duration_ms", - "optional": true, - "nullable": false, + "docstring": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/silence_duration_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold": { "kind": "HttpDeclProperty", - "docstring": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/threshold", + "deprecated": false, "key": "threshold", - "optional": true, - "nullable": false, + "docstring": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/threshold", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, only `server_vad` is currently supported.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "Type of turn detection, only `server_vad` is currently supported.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "ident": "RealtimeTranscriptionSessionTurnDetection", "type": { "kind": "HttpTypeObject", @@ -27881,7 +28003,6 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms", @@ -27892,22 +28013,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { "kind": "HttpDeclProperty", - "docstring": "The sample rate of the audio. Always `24000`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", + "deprecated": false, "key": "rate", - "optional": true, - "nullable": false, + "docstring": "The sample rate of the audio. Always `24000`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", "types": [ { "kind": "HttpTypeLiteral", "literal": 24000 } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27916,22 +28037,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcm`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcm`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcm" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27940,22 +28061,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcmu`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcmu`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcmu" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -27964,22 +28085,22 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcma`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcma`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcma" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28003,9 +28124,11 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime > (model) noise_reduction_type > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/NoiseReductionType", + "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", "ident": "NoiseReductionType", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/NoiseReductionType", "types": [ { "kind": "HttpTypeLiteral", @@ -28015,10 +28138,8 @@ Schema name: `RealtimeServerEventSessionCreated` "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", @@ -28037,14 +28158,24 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -28065,10 +28196,8 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] }, - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", @@ -28076,28 +28205,30 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", - "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7" ] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "server_vad", + "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "server_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", - "deprecated": false, + "default": "server_vad", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28106,25 +28237,25 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) create_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) idle_timeout_ms": { "kind": "HttpDeclProperty", - "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", + "deprecated": false, "key": "idle_timeout_ms", - "optional": true, - "nullable": true, + "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", "type": { "kind": "HttpTypeNumber" }, @@ -28132,86 +28263,86 @@ Schema name: `RealtimeServerEventSessionCreated` "minimum": 5000, "maximum": 30000 }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) interrupt_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) prefix_padding_ms": { "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", + "deprecated": false, "key": "prefix_padding_ms", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) silence_duration_ms": { "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", + "deprecated": false, "key": "silence_duration_ms", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) threshold": { "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", + "deprecated": false, "key": "threshold", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "semantic_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28220,28 +28351,28 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) create_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness": { "kind": "HttpDeclProperty", - "docstring": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", + "deprecated": false, "key": "eagerness", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", "types": [ { "kind": "HttpTypeLiteral", @@ -28259,11 +28390,11 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28275,16 +28406,16 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) interrupt_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, @@ -28367,23 +28498,23 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28427,23 +28558,23 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28480,23 +28611,23 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -28505,44 +28636,44 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only": { "kind": "HttpDeclProperty", - "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always": { "kind": "HttpDeclProperty", - "title": "MCP tool filter", - "docstring": "A filter object to specify which tools are allowed.\n", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", + "deprecated": false, "key": "always", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -28554,8 +28685,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -28565,11 +28696,11 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never": { "kind": "HttpDeclProperty", - "title": "MCP tool filter", - "docstring": "A filter object to specify which tools are allowed.\n", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", + "deprecated": false, "key": "never", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -28581,8 +28712,8 @@ Schema name: `RealtimeServerEventSessionCreated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -28616,14 +28747,24 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -28644,10 +28785,8 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] }, - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", @@ -28655,7 +28794,9 @@ Schema name: `RealtimeServerEventSessionCreated` "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", - "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7" ] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0": { @@ -28697,31 +28838,45 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe" + "literal": "gpt-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe-2025-12-15" + "literal": "gpt-live-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe" + "literal": "gpt-4o-mini-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe-diarize" + "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe" + } + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe-diarize" + } + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -28793,67 +28948,67 @@ Schema name: `RealtimeServerEventSessionCreated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only": { "kind": "HttpDeclProperty", - "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only": { "kind": "HttpDeclProperty", - "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, @@ -28868,31 +29023,45 @@ Schema name: `RealtimeServerEventSessionCreated` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe" + "literal": "gpt-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe-2025-12-15" + "literal": "gpt-live-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe" + "literal": "gpt-4o-mini-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe-diarize" + "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe" + } + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe-diarize" + } + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -28969,6 +29138,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) session_updated_event > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated", + "docstring": "Returned when a session is updated with a `session.update` event, unless\nthere is an error.\n", "ident": "SessionUpdatedEvent", "type": { "kind": "HttpTypeObject", @@ -28984,7 +29154,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Returned when a session is updated with a `session.update` event, unless\nthere is an error.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) session_updated_event > (schema) > (property) event_id", @@ -28994,26 +29163,27 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) session_updated_event > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) session_updated_event > (schema) > (property) session": { "kind": "HttpDeclProperty", - "docstring": "The session configuration.", + "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/session", + "deprecated": false, "key": "session", - "optional": false, - "nullable": false, + "docstring": "The session configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/session", "types": [ { "kind": "HttpTypeReference", @@ -29025,11 +29195,10 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "RealtimeTranscriptionSessionCreateResponse", "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/session" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/session", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -29039,22 +29208,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) session_updated_event > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `session.updated`.", + "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `session.updated`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "session.updated" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventSessionUpdated/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29108,6 +29277,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA", + "docstring": "A Realtime session configuration object.\n", "ident": "RealtimeSessionCreateResponse", "type": { "kind": "HttpTypeObject", @@ -29162,7 +29332,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "A Realtime session configuration object.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id", @@ -29186,6 +29355,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA", + "docstring": "A Realtime transcription session configuration object.\n", "ident": "RealtimeTranscriptionSessionCreateResponse", "type": { "kind": "HttpTypeObject", @@ -29210,7 +29380,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "A Realtime transcription session configuration object.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id", @@ -29230,36 +29399,36 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type. Always `realtime.session`.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type. Always `realtime.session`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.session" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29268,22 +29437,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of session to create. Always `realtime` for the Realtime API.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29292,10 +29461,10 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input and output audio.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for input and output audio.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -29307,8 +29476,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29318,43 +29487,43 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": true, - "nullable": false, + "docstring": "Expiration timestamp for the session, in seconds since epoch.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/expires_at", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) include": { "kind": "HttpDeclProperty", - "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", + "deprecated": false, "key": "include", - "optional": true, - "nullable": false, + "docstring": "Additional fields to include in server outputs.\n\n`item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include/items", "types": [ { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/include", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -29363,45 +29532,45 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) instructions": { "kind": "HttpDeclProperty", - "docstring": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/instructions", + "deprecated": false, "key": "instructions", - "optional": true, - "nullable": false, + "docstring": "The default system instructions (i.e. system message) prepended to model calls. This field allows the client to guide the model on desired responses. The model can be instructed on response content and format, (e.g. \"be extremely succinct\", \"act friendly\", \"here are examples of good responses\") and on audio behavior (e.g. \"talk quickly\", \"inject emotion into your voice\", \"laugh frequently\"). The instructions are not guaranteed to be followed by the model, but they provide guidance to the model on the desired behavior.\n\nNote that the server sets default instructions which will be used if this field is not set and are visible in the `session.created` event at the start of the session.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/instructions", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) max_output_tokens": { "kind": "HttpDeclProperty", - "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", + "deprecated": false, "key": "max_output_tokens", - "optional": true, - "nullable": false, + "docstring": "Maximum number of output tokens for a single assistant response,\ninclusive of tool calls. Provide an integer between 1 and 4096 to\nlimit output tokens, or `inf` for the maximum available tokens for a\ngiven model. Defaults to `inf`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", "types": [ { "kind": "HttpTypeNumber" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -29411,18 +29580,20 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The Realtime model used for this session.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The Realtime model used for this session.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -29500,14 +29671,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-12-15" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -29517,17 +29686,16 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) output_modalities": { "kind": "HttpDeclProperty", - "docstring": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", + "deprecated": false, "key": "output_modalities", - "optional": true, - "nullable": false, - "default": [ - "audio" - ], + "docstring": "The set of modalities the model can respond with. It defaults to `[\"audio\"]`, indicating\nthat the model will respond with audio plus a transcript. `[\"text\"]` can be used to make\nthe model respond with text only. It is not possible to request both `text` and `audio` at the same time.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities/items", "types": [ { "kind": "HttpTypeLiteral", @@ -29537,13 +29705,14 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "audio" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/output_modalities", - "deprecated": false, + "default": [ + "audio" + ], + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -29553,19 +29722,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": true, + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "type": { "kind": "HttpTypeReference", "ident": "ResponsePrompt", "$ref": "(resource) responses > (model) response_prompt > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/prompt", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) responses > (model) response_prompt", "childrenParentSchema": "object", "children": [ @@ -29576,20 +29745,20 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) reasoning": { "kind": "HttpDeclProperty", - "title": "Realtime reasoning configuration", - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/reasoning", + "deprecated": false, "key": "reasoning", - "optional": true, - "nullable": false, + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", + "title": "Realtime reasoning configuration", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoning", "$ref": "(resource) realtime > (model) realtime_reasoning > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/reasoning", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime > (model) realtime_reasoning", "childrenParentSchema": "object", "children": [ @@ -29598,13 +29767,13 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tool_choice": { "kind": "HttpDeclProperty", - "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", + "deprecated": false, "key": "tool_choice", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "How the model chooses tools. Provide one of the string modes or force a specific\nfunction/MCP tool.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", "types": [ { "kind": "HttpTypeReference", @@ -29621,11 +29790,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "ToolChoiceMcp", "$ref": "(resource) responses > (model) tool_choice_mcp > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tool_choice", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -29636,14 +29805,16 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "Tools available to the model.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", + "deprecated": false, "key": "tools", - "optional": true, - "nullable": false, + "docstring": "Tools available to the model.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items", "types": [ { "kind": "HttpTypeReference", @@ -29691,13 +29862,11 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items" - }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools" + ] + } }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "union", "children": [ @@ -29707,23 +29876,24 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing": { "kind": "HttpDeclProperty", - "title": "Tracing Configuration", - "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", + "deprecated": false, "key": "tracing", - "optional": true, - "nullable": true, + "docstring": "Realtime API can write session traces to the [Traces Dashboard](https://platform.openai.com/logs?api=traces). Set to null to disable tracing. Once\ntracing is enabled for a session, the configuration cannot be modified.\n\n`auto` will create a trace for the session with default values for the\nworkflow name, group id, and metadata.\n", + "title": "Tracing Configuration", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" + ] }, { "kind": "HttpTypeObject", @@ -29739,11 +29909,10 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -29753,20 +29922,20 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) truncation": { "kind": "HttpDeclProperty", - "title": "Realtime Truncation Controls", - "docstring": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/truncation", + "deprecated": false, "key": "truncation", - "optional": true, - "nullable": false, + "docstring": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.\n", + "title": "Realtime Truncation Controls", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTruncation", "$ref": "(resource) realtime > (model) realtime_truncation > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/truncation", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_truncation", "childrenParentSchema": "union", "children": [ @@ -29776,50 +29945,50 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "Unique identifier for the session that looks like `sess_1234567890abcdef`.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "The object type. Always `realtime.transcription_session`.", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/object", + "deprecated": false, "key": "object", - "optional": false, - "nullable": false, + "docstring": "The object type. Always `realtime.transcription_session`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/object", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of session. Always `transcription` for transcription sessions.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of session. Always `transcription` for transcription sessions.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "transcription" } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -29828,10 +29997,10 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio for the session.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio for the session.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -29840,8 +30009,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29850,43 +30019,43 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) expires_at": { "kind": "HttpDeclProperty", - "docstring": "Expiration timestamp for the session, in seconds since epoch.", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/expires_at", + "deprecated": false, "key": "expires_at", - "optional": true, - "nullable": false, + "docstring": "Expiration timestamp for the session, in seconds since epoch.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "unixtime" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/expires_at", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) include": { "kind": "HttpDeclProperty", - "docstring": "Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", + "deprecated": false, "key": "include", - "optional": true, - "nullable": false, + "docstring": "Additional fields to include in server outputs.\n- `item.input_audio_transcription.logprobs`: Include logprobs for input audio transcription.\n", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include/items", "types": [ { "kind": "HttpTypeLiteral", "literal": "item.input_audio_transcription.logprobs" } - ], - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include/items" - }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include" + ] + } }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/include", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -29909,9 +30078,9 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input", + "deprecated": false, "key": "input", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -29929,8 +30098,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29942,9 +30111,9 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -29959,8 +30128,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -29991,13 +30160,13 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "inf" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/max_output_tokens/oneOf/1" + ] }, "childrenParentSchema": "enum", "children": [ @@ -30016,9 +30185,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", + "docstring": "The Realtime model used for this session.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -30096,10 +30267,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "gpt-audio-mini-2025-12-15" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/model/anyOf/1" + ] }, - "docstring": "The Realtime model used for this session.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) model > (variant) 1 > (member) 0", @@ -30139,27 +30308,28 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_prompt > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique identifier of the prompt template to use.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique identifier of the prompt template to use.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema) > (property) variables": { "kind": "HttpDeclProperty", - "title": "Prompt Variables", - "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", + "deprecated": false, "key": "variables", - "optional": true, - "nullable": true, + "docstring": "Optional map of values to substitute in for variables in your\nprompt. The substitution values can either be strings, or other\nResponse input types like images or files.\n", + "title": "Prompt Variables", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", "ident": "Record", "typeParameters": [ { @@ -30167,6 +30337,7 @@ Schema name: `RealtimeServerEventSessionUpdated` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties", "types": [ { "kind": "HttpTypeString" @@ -30186,14 +30357,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "ident": "ResponseInputFile", "$ref": "(resource) responses > (model) response_input_file > (schema)" } - ], - "oasRef": "#/components/schemas/ResponsePromptVariables/anyOf/0/additionalProperties" + ] } - ], - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables" + ] }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/variables", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "childrenParentSchema": "union", "children": [ @@ -30205,21 +30374,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_prompt > (schema) > (property) version": { "kind": "HttpDeclProperty", - "docstring": "Optional version of the prompt template.", + "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", + "deprecated": false, "key": "version", - "optional": true, - "nullable": true, + "docstring": "Optional version of the prompt template.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/Prompt/anyOf/0/properties/version", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_prompt > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/Prompt", + "docstring": "Reference to a prompt template and its variables.\n[Learn more](/docs/guides/text?api-mode=responses#reusable-prompts).\n", "ident": "ResponsePrompt", "type": { "kind": "HttpTypeObject", @@ -30235,7 +30405,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "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", @@ -30245,20 +30414,20 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort": { "kind": "HttpDeclProperty", - "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", + "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", + "deprecated": false, "key": "effort", - "optional": true, - "nullable": false, - "default": "low", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeReasoningEffort", "$ref": "(resource) realtime > (model) realtime_reasoning_effort > (schema)" }, - "oasRef": "#/components/schemas/RealtimeReasoning/properties/effort", - "deprecated": false, - "schemaType": "enum", + "default": "low", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) realtime_reasoning_effort", "childrenParentSchema": "enum", "children": [ @@ -30272,6 +30441,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_reasoning > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoning", + "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "ident": "RealtimeReasoning", "type": { "kind": "HttpTypeObject", @@ -30281,7 +30451,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Configuration for reasoning-capable Realtime models such as `gpt-realtime-2`.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_reasoning > (schema) > (property) effort" @@ -30331,9 +30500,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) tool_choice_options > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceOptions", + "docstring": "Controls which (if any) tool is called by the model.\n\n`none` means the model will not call any tool and instead generates a message.\n\n`auto` means the model can pick between generating a message or calling one or\nmore tools.\n\n`required` means the model must call one or more tools.\n", "ident": "ToolChoiceOptions", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceOptions", "types": [ { "kind": "HttpTypeLiteral", @@ -30347,10 +30518,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "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", @@ -30361,6 +30530,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) tool_choice_function > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceFunction", + "docstring": "Use this option to force the model to call a specific function.\n", "ident": "ToolChoiceFunction", "type": { "kind": "HttpTypeObject", @@ -30373,7 +30543,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "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", @@ -30383,6 +30552,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) tool_choice_mcp > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/ToolChoiceMCP", + "docstring": "Use this option to force the model to call a specific tool on a remote MCP server.\n", "ident": "ToolChoiceMcp", "type": { "kind": "HttpTypeObject", @@ -30398,7 +30568,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "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", @@ -30424,6 +30593,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tools/items/oneOf/1", + "docstring": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).\n", "ident": "McpTool", "type": { "kind": "HttpTypeObject", @@ -30466,7 +30636,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "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.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label", @@ -30515,18 +30684,18 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", + "docstring": "Enables tracing and sets default values for tracing configuration options. Always `auto`.\n", "ident": "Auto", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/0" + ] }, - "docstring": "Enables tracing and sets default values for tracing configuration options. Always `auto`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 0 > (member) 0" @@ -30535,6 +30704,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1", + "docstring": "Granular configuration for tracing.\n", "ident": "TracingConfiguration", "type": { "kind": "HttpTypeObject", @@ -30550,7 +30720,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Granular configuration for tracing.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id", @@ -30561,9 +30730,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", + "docstring": "The truncation strategy to use for the session. `auto` is the default truncation strategy. `disabled` will disable truncation and emit errors when the conversation exceeds the input token limit.", "ident": "UnionMember0", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -30573,10 +30744,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "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", @@ -30586,6 +30755,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1", + "docstring": "Retain a fraction of the conversation tokens when the conversation exceeds the input token limit. This allows you to amortize truncations across multiple turns, which can help improve cached token usage.", "ident": "RetentionRatioTruncation", "type": { "kind": "HttpTypeObject", @@ -30601,7 +30771,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "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", @@ -30612,12 +30781,15 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_truncation > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTruncation", + "docstring": "When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only include 28,224 tokens in the context before truncation occurs.\n\nClients can configure truncation behavior to truncate with a lower max token limit, which is an effective way to control token usage and cost.\n\nTruncation will reduce the number of cached tokens on the next turn (busting the cache), since messages are dropped from the beginning of the context. However, clients can also configure truncation to retain messages up to a fraction of the maximum context size, which will reduce the need for future truncations and thus improve the cache rate.\n\nTruncation can be disabled entirely, which means the server will never truncate but would instead return an error if the conversation exceeds the model's input token limit.\n", "ident": "RealtimeTruncation", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation", "types": [ { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0", "types": [ { "kind": "HttpTypeLiteral", @@ -30627,8 +30799,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "disabled" } - ], - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/0" + ] }, { "kind": "HttpTypeObject", @@ -30644,10 +30815,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] } - ], - "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", @@ -30663,9 +30832,9 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input", + "deprecated": false, "key": "input", - "optional": true, - "nullable": false, "type": { "kind": "HttpTypeObject", "members": [ @@ -30683,8 +30852,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -30703,19 +30872,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the input audio.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the input audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -30726,10 +30895,10 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", + "deprecated": false, "key": "noise_reduction", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio noise reduction. This can be set to `null` to turn off.\nNoise reduction filters audio added to the input audio buffer before it is sent to VAD and the model.\nFiltering the audio can improve VAD and turn detection accuracy (reducing false positives) and model performance by improving perception of the input audio.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -30738,8 +30907,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -30748,16 +30917,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", + "deprecated": false, "key": "transcription", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio transcription, defaults to off and can be set to `null` to turn off once on. Input audio transcription is not native to the model, since the model consumes audio directly. Transcription runs asynchronously through [the /audio/transcriptions endpoint](/docs/api-reference/audio/createTranscription) and should be treated as guidance of input audio content rather than precisely what the model heard. The client can optionally set the language and prompt for transcription, these offer additional guidance to the transcription service.\n", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "language" }, + { + "ident": "languages" + }, { "ident": "model" }, @@ -30766,25 +30938,27 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", - "title": "Realtime Turn Detection", - "docstring": "Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\n\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\n\nSemantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, "key": "turn_detection", - "optional": true, - "nullable": true, + "docstring": "Configuration for turn detection, ether Server VAD or Semantic VAD. This can be set to `null` to turn off, in which case the client must manually trigger model response.\n\nServer VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech.\n\nSemantic VAD is more advanced and uses a turn detection model (in conjunction with VAD) to semantically estimate whether the user has finished speaking, then dynamically sets a timeout based on this probability. For example, if user audio trails off with \"uhhm\", the model will score a low probability of turn end and wait longer for the user to continue speaking. This can be useful for more natural conversations, but may have a higher latency.\n\nFor `gpt-realtime-whisper` transcription sessions, turn detection must be\nset to `null`; VAD is not supported.\n", + "title": "Realtime Turn Detection", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", "types": [ { "kind": "HttpTypeObject", @@ -30829,11 +31003,10 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection" + ] }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -30843,19 +31016,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The format of the output audio.", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The format of the output audio.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -30866,38 +31039,39 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) speed": { "kind": "HttpDeclProperty", - "docstring": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/speed", + "deprecated": false, "key": "speed", - "optional": true, - "nullable": false, - "default": 1, + "docstring": "The speed of the model's spoken response as a multiple of the original speed.\n1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress.\n\nThis parameter is a post-processing adjustment to the audio after it is generated, it's\nalso possible to prompt the model to speak faster or slower.\n", "type": { "kind": "HttpTypeNumber" }, "constraints": { - "maximum": 1.5, - "minimum": 0.25 + "minimum": 0.25, + "maximum": 1.5 }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/speed", - "deprecated": false, + "default": 1, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice": { "kind": "HttpDeclProperty", - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", + "deprecated": false, "key": "voice", - "optional": true, - "nullable": false, - "default": "alloy", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -30939,17 +31113,16 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice" + ] }, + "default": "alloy", "examples": [ "ash" ], - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/output/properties/voice", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -31157,6 +31330,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) response_input_text > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputTextContent", + "docstring": "A text input to the model.", "ident": "ResponseInputText", "type": { "kind": "HttpTypeObject", @@ -31172,7 +31346,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "A text input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_text > (schema) > (property) text", @@ -31183,6 +31356,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) response_input_image > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputImageContent", + "docstring": "An image input to the model. Learn about [image inputs](/docs/guides/vision).", "ident": "ResponseInputImage", "type": { "kind": "HttpTypeObject", @@ -31204,7 +31378,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "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", @@ -31217,6 +31390,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) responses > (model) response_input_file > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/InputFileContent", + "docstring": "A file input to the model.", "ident": "ResponseInputFile", "type": { "kind": "HttpTypeObject", @@ -31244,7 +31418,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "A file input to the model.", "childrenParentSchema": "object", "children": [ "(resource) responses > (model) response_input_file > (schema) > (property) type", @@ -31294,9 +31467,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_reasoning_effort > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeReasoningEffort", + "docstring": "Constrains effort on reasoning for reasoning-capable Realtime models such as\n`gpt-realtime-2`.\n", "ident": "RealtimeReasoningEffort", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeReasoningEffort", "types": [ { "kind": "HttpTypeLiteral", @@ -31318,10 +31493,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "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", @@ -31354,36 +31527,36 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) tool_choice_function > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function to call.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function to call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_function > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For function calling, the type is always `function`.", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For function calling, the type is always `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceFunction/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31392,36 +31565,36 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server to use.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server to use.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "For MCP tools, the type is always `mcp`.", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "For MCP tools, the type is always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type" + ] }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31430,78 +31603,78 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) tool_choice_mcp > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to call on the server.\n", + "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": true, + "docstring": "The name of the tool to call on the server.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/ToolChoiceMCP/properties/name", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": false, + "docstring": "The description of the function, including guidance on when and how\nto call it, and guidance about what to tell the user when calling\n(if anything).\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", + "deprecated": false, "key": "name", - "optional": true, - "nullable": false, + "docstring": "The name of the function.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) parameters": { "kind": "HttpDeclProperty", - "docstring": "Parameters of the function in JSON Schema.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", + "deprecated": false, "key": "parameters", - "optional": true, - "nullable": false, + "docstring": "Parameters of the function in JSON Schema.", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/parameters", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_function_tool > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the tool, i.e. `function`.", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The type of the tool, i.e. `function`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function" } - ], - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeFunctionTool/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31510,36 +31683,36 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "A label for this MCP server, used to identify it in tool calls.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "A label for this MCP server, used to identify it in tool calls.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the MCP tool. Always `mcp`.", + "oasRef": "#/components/schemas/MCPTool/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the MCP tool. Always `mcp`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/type" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31548,14 +31721,16 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_callers": { "kind": "HttpDeclProperty", - "docstring": "The tool invocation context(s).", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", + "deprecated": false, "key": "allowed_callers", - "optional": true, - "nullable": true, + "docstring": "The tool invocation context(s).", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", "elementType": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items", "types": [ { "kind": "HttpTypeLiteral", @@ -31565,13 +31740,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "programmatic" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers/anyOf/0/items" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers" + ] + } }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_callers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "array", "childrenParentSchema": "enum", "children": [ @@ -31581,19 +31754,20 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools": { "kind": "HttpDeclProperty", - "docstring": "List of allowed tool names or a filter object.\n", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", + "deprecated": false, "key": "allowed_tools", - "optional": true, - "nullable": true, + "docstring": "List of allowed tool names or a filter object.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", "types": [ { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" - }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" + } }, { "kind": "HttpTypeObject", @@ -31606,11 +31780,10 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -31620,26 +31793,27 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) authorization": { "kind": "HttpDeclProperty", - "docstring": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n", + "oasRef": "#/components/schemas/MCPTool/properties/authorization", + "deprecated": false, "key": "authorization", - "optional": true, - "nullable": false, + "docstring": "An OAuth access token that can be used with a remote MCP server, either\nwith a custom MCP server URL or a service connector. Your application\nmust handle the OAuth authorization flow and provide the token here.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/authorization", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) connector_id": { "kind": "HttpDeclProperty", - "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", + "deprecated": false, "key": "connector_id", - "optional": true, - "nullable": false, + "docstring": "Identifier for service connectors, like those available in ChatGPT. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more\nabout service connectors [here](/docs/guides/tools-remote-mcp#connectors).\n\nCurrently supported `connector_id` values are:\n\n- Dropbox: `connector_dropbox`\n- Gmail: `connector_gmail`\n- Google Calendar: `connector_googlecalendar`\n- Google Drive: `connector_googledrive`\n- Microsoft Teams: `connector_microsoftteams`\n- Outlook Calendar: `connector_outlookcalendar`\n- Outlook Email: `connector_outlookemail`\n- SharePoint: `connector_sharepoint`\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/connector_id", "types": [ { "kind": "HttpTypeLiteral", @@ -31673,11 +31847,10 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "connector_sharepoint" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/connector_id" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/connector_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31693,26 +31866,27 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) defer_loading": { "kind": "HttpDeclProperty", - "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", + "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", + "deprecated": false, "key": "defer_loading", - "optional": true, - "nullable": false, + "docstring": "Whether this MCP tool is deferred and discovered via tool search.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPTool/properties/defer_loading", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) headers": { "kind": "HttpDeclProperty", - "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", + "oasRef": "#/components/schemas/MCPTool/properties/headers", + "deprecated": false, "key": "headers", - "optional": true, - "nullable": true, + "docstring": "Optional HTTP headers to send to the MCP server. Use for authentication\nor other purposes.\n", "type": { "kind": "HttpTypeReference", + "oasRef": "#/components/schemas/MCPTool/properties/headers", "ident": "Record", "typeParameters": [ { @@ -31721,23 +31895,22 @@ Schema name: `RealtimeServerEventSessionUpdated` { "kind": "HttpTypeString" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/headers" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/headers", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "map", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval": { "kind": "HttpDeclProperty", - "docstring": "Specify which of the MCP server's tools require approval.", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", + "deprecated": false, "key": "require_approval", - "optional": true, - "nullable": true, - "default": "always", + "docstring": "Specify which of the MCP server's tools require approval.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval", "types": [ { "kind": "HttpTypeObject", @@ -31752,6 +31925,7 @@ Schema name: `RealtimeServerEventSessionUpdated` }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -31761,14 +31935,13 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "never" } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1" + ] } - ], - "oasRef": "#/components/schemas/MCPTool/properties/require_approval" + ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval", - "deprecated": false, + "default": "always", + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -31778,46 +31951,46 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_description": { "kind": "HttpDeclProperty", - "docstring": "Optional description of the MCP server, used to provide more context.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_description", + "deprecated": false, "key": "server_description", - "optional": true, - "nullable": false, + "docstring": "Optional description of the MCP server, used to provide more context.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_description", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) server_url": { "kind": "HttpDeclProperty", - "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", + "oasRef": "#/components/schemas/MCPTool/properties/server_url", + "deprecated": false, "key": "server_url", - "optional": true, - "nullable": false, + "docstring": "The URL for the MCP server. One of `server_url`, `connector_id`, or\n`tunnel_id` must be provided.\n", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/MCPTool/properties/server_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) tunnel_id": { "kind": "HttpDeclProperty", - "docstring": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.\n", + "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", + "deprecated": false, "key": "tunnel_id", - "optional": true, - "nullable": false, + "docstring": "The Secure MCP Tunnel ID to use instead of a direct server URL. One of\n`server_url`, `connector_id`, or `tunnel_id` must be provided.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPTool/properties/tunnel_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -31830,43 +32003,43 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) group_id": { "kind": "HttpDeclProperty", - "docstring": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/group_id", + "deprecated": false, "key": "group_id", - "optional": true, - "nullable": false, + "docstring": "The group id to attach to this trace to enable filtering and\ngrouping in the Traces Dashboard.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/group_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) metadata": { "kind": "HttpDeclProperty", - "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/metadata", + "deprecated": false, "key": "metadata", - "optional": true, - "nullable": false, + "docstring": "The arbitrary metadata to attach to this trace to enable\nfiltering in the Traces Dashboard.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/metadata", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tracing > (variant) 1 > (property) workflow_name": { "kind": "HttpDeclProperty", - "docstring": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/workflow_name", + "deprecated": false, "key": "workflow_name", - "optional": true, - "nullable": false, + "docstring": "The name of the workflow to attach to this trace. This is used to\nname the trace in the Traces Dashboard.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/tracing/anyOf/0/oneOf/1/properties/workflow_name", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, @@ -31886,10 +32059,10 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) retention_ratio": { "kind": "HttpDeclProperty", - "docstring": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.\n", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", + "deprecated": false, "key": "retention_ratio", - "optional": false, - "nullable": false, + "docstring": "Fraction of post-instruction conversation tokens to retain (`0.0` - `1.0`) when the conversation exceeds the input token limit. Setting this to `0.8` means that messages will be dropped until 80% of the maximum allowed tokens are used. This helps reduce the frequency of truncations and improve cache rates.\n", "type": { "kind": "HttpTypeNumber" }, @@ -31897,29 +32070,29 @@ Schema name: `RealtimeServerEventSessionUpdated` "minimum": 0, "maximum": 1 }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/retention_ratio", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Use retention ratio truncation.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Use retention ratio truncation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "retention_ratio" } - ], - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -31928,10 +32101,10 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits": { "kind": "HttpDeclProperty", - "docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", + "deprecated": false, "key": "token_limits", - "optional": true, - "nullable": false, + "docstring": "Optional custom token limits for this truncation strategy. If not provided, the model's default token limits will be used.", "type": { "kind": "HttpTypeObject", "members": [ @@ -31940,8 +32113,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -31950,19 +32123,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) format": { "kind": "HttpDeclProperty", - "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/format", + "deprecated": false, "key": "format", - "optional": true, - "nullable": false, + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "type": { "kind": "HttpTypeReference", "ident": "RealtimeAudioFormats", "$ref": "(resource) realtime > (model) realtime_audio_formats > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/format", - "deprecated": false, - "schemaType": "union", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) realtime_audio_formats", "childrenParentSchema": "union", "children": [ @@ -31973,10 +32146,10 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction": { "kind": "HttpDeclProperty", - "docstring": "Configuration for input audio noise reduction.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", + "deprecated": false, "key": "noise_reduction", - "optional": true, - "nullable": false, + "docstring": "Configuration for input audio noise reduction.\n", "type": { "kind": "HttpTypeObject", "members": [ @@ -31985,8 +32158,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -31995,16 +32168,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription": { "kind": "HttpDeclProperty", - "docstring": "Configuration of the transcription model.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", + "deprecated": false, "key": "transcription", - "optional": true, - "nullable": false, + "docstring": "Configuration of the transcription model.\n", "type": { "kind": "HttpTypeObject", "members": [ { "ident": "language" }, + { + "ident": "languages" + }, { "ident": "model" }, @@ -32013,31 +32189,32 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/transcription", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt" ] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection": { "kind": "HttpDeclProperty", - "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "deprecated": false, "key": "turn_detection", - "optional": true, - "nullable": true, + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "type": { "kind": "HttpTypeReference", "ident": "RealtimeTranscriptionSessionTurnDetection", "$ref": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", - "deprecated": false, - "schemaType": "object", + "optional": true, + "nullable": true, "modelImplicit": false, + "schemaType": "object", "modelPath": "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection", "childrenParentSchema": "object", "children": [ @@ -32050,7 +32227,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0", - "ident": "PCMAudioFormat", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", + "ident": "PCMAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -32062,7 +32240,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "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", @@ -32072,7 +32249,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1", - "ident": "PCMUAudioFormat", + "docstring": "The G.711 μ-law format.", + "ident": "PCMUAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -32081,7 +32259,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "The G.711 μ-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type" @@ -32090,7 +32267,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2", - "ident": "PCMAAudioFormat", + "docstring": "The G.711 A-law format.", + "ident": "PCMAAudio", "type": { "kind": "HttpTypeObject", "members": [ @@ -32099,7 +32277,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "The G.711 A-law format.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type" @@ -32108,9 +32285,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) realtime_audio_formats > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeAudioFormats", + "docstring": "The PCM audio format. Only a 24kHz sample rate is supported.", "ident": "RealtimeAudioFormats", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats", "types": [ { "kind": "HttpTypeObject", @@ -32139,10 +32318,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] } - ], - "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", @@ -32152,19 +32329,19 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", + "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", "type": { "kind": "HttpTypeReference", "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", - "deprecated": false, - "schemaType": "enum", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) noise_reduction_type", "childrenParentSchema": "enum", "children": [ @@ -32174,37 +32351,65 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { "kind": "HttpDeclProperty", - "docstring": "The language of the input audio.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", + "deprecated": false, "key": "language", + "docstring": "The language of the input audio.\n", + "type": { + "kind": "HttpTypeString" + }, "optional": true, "nullable": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages": { + "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "deprecated": false, + "key": "languages", + "docstring": "The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n", "type": { + "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", - "deprecated": false, - "schemaType": "string", + "optional": true, + "nullable": false, + "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -32225,14 +32430,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" + ] }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -32242,21 +32445,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "The prompt configured for input audio transcription, when present.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": false, + "docstring": "The prompt configured for input audio transcription, when present.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0", + "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "ident": "ServerVad", "type": { "kind": "HttpTypeObject", @@ -32284,7 +32488,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Server-side voice activity detection (VAD) which flips on when user speech is detected and off after a period of silence.", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type", @@ -32299,6 +32502,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1", + "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "ident": "SemanticVad", "type": { "kind": "HttpTypeObject", @@ -32317,7 +32521,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Server-side semantic turn detection which uses a model to determine when the user has finished speaking.", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type", @@ -32338,9 +32541,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", + "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -32382,10 +32587,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "cedar" } - ], - "oasRef": "#/components/schemas/VoiceIdsShared/anyOf/1" + ] }, - "docstring": "The voice the model uses to respond. Voice cannot be changed during the\nsession once the model has responded with audio at least once. Current\nvoice options are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`,\n`shimmer`, `verse`, `marin`, and `cedar`. We recommend `marin` and `cedar` for\nbest quality.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) output > (property) voice > (variant) 1 > (member) 0", @@ -32402,37 +32605,37 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_text > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text input to the model.", + "oasRef": "#/components/schemas/InputTextContent/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text input to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputTextContent/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_text > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_text`.", + "oasRef": "#/components/schemas/InputTextContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_text", + "docstring": "The type of the input item. Always `input_text`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputTextContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/InputTextContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/type", - "deprecated": false, + "default": "input_text", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32441,11 +32644,11 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -32454,8 +32657,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/InputTextContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -32464,12 +32667,13 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_image > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": false, - "nullable": false, + "docstring": "The detail level of the image to be sent to the model. One of `high`, `low`, `auto`, or `original`. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -32487,11 +32691,10 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "original" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/detail", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32503,23 +32706,23 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_image > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_image`.", + "oasRef": "#/components/schemas/InputImageContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_image", + "docstring": "The type of the input item. Always `input_image`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputImageContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/InputImageContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/type", - "deprecated": false, + "default": "input_image", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32528,42 +32731,42 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_image > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputImageContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputImageContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", + "oasRef": "#/components/schemas/InputImageContent/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": true, + "docstring": "The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputImageContent/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -32572,8 +32775,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/InputImageContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -32582,23 +32785,23 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_file > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the input item. Always `input_file`.", + "oasRef": "#/components/schemas/InputFileContent/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "input_file", + "docstring": "The type of the input item. Always `input_file`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_file" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/type" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/type", - "deprecated": false, + "default": "input_file", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32607,12 +32810,13 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_file > (schema) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, + "docstring": "The detail level of the file to be sent to the model. Use `auto` to let the system select the detail level; for GPT-5.6 and later models, `auto` uses high-quality rendering, which may increase input token usage. Use `low` for lower-cost rendering, or `high` to render the file at higher quality. Defaults to `auto`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/InputFileContent/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -32626,11 +32830,10 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/InputFileContent/properties/detail" + ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/detail", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -32641,70 +32844,70 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_file > (schema) > (property) file_data": { "kind": "HttpDeclProperty", - "docstring": "The content of the file to be sent to the model.\n", + "oasRef": "#/components/schemas/InputFileContent/properties/file_data", + "deprecated": false, "key": "file_data", - "optional": true, - "nullable": false, + "docstring": "The content of the file to be sent to the model.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_data", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_id", + "deprecated": false, "key": "file_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) file_url": { "kind": "HttpDeclProperty", - "docstring": "The URL of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/file_url", + "deprecated": false, "key": "file_url", - "optional": true, - "nullable": false, + "docstring": "The URL of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/InputFileContent/properties/file_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) filename": { "kind": "HttpDeclProperty", - "docstring": "The name of the file to be sent to the model.", + "oasRef": "#/components/schemas/InputFileContent/properties/filename", + "deprecated": false, "key": "filename", - "optional": true, - "nullable": false, + "docstring": "The name of the file to be sent to the model.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/InputFileContent/properties/filename", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint": { "kind": "HttpDeclProperty", - "title": "Prompt cache breakpoint", - "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", + "deprecated": false, "key": "prompt_cache_breakpoint", - "optional": true, - "nullable": false, + "docstring": "Marks the exact end of a reusable prompt prefix. The breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block.", + "title": "Prompt cache breakpoint", "type": { "kind": "HttpTypeObject", "members": [ @@ -32713,8 +32916,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/InputFileContent/properties/prompt_cache_breakpoint", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -32766,20 +32969,21 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", + "docstring": "A string array of allowed tool names", "ident": "McpAllowedTools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/0" - }, - "docstring": "A string array of allowed tool names", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/allowed_tools/anyOf/0/oneOf/1", + "docstring": "A filter object to specify which tools are allowed.\n", "ident": "McpToolFilter", "type": { "kind": "HttpTypeObject", @@ -32792,7 +32996,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "A filter object to specify which tools are allowed.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only", @@ -32858,6 +33061,7 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0", + "docstring": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n", "ident": "McpToolApprovalFilter", "type": { "kind": "HttpTypeObject", @@ -32870,7 +33074,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Specify which of the MCP server's tools require approval. Can be\n`always`, `never`, or a filter object associated with tools\nthat require approval.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always", @@ -32880,9 +33083,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", + "docstring": "Specify a single approval policy for all tools. One of `always` or\n`never`. When set to `always`, all tools will require approval. When\nset to `never`, all tools will not require approval.\n", "ident": "McpToolApprovalSetting", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/1", "types": [ { "kind": "HttpTypeLiteral", @@ -32892,10 +33097,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "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.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 1 > (member) 0", @@ -32911,36 +33114,36 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_truncation > (schema) > (variant) 1 > (property) token_limits > (property) post_instructions": { "kind": "HttpDeclProperty", - "docstring": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.", + "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", + "deprecated": false, "key": "post_instructions", - "optional": true, - "nullable": false, + "docstring": "Maximum tokens allowed in the conversation after instructions (which including tool definitions). For example, setting this to 5,000 would mean that truncation would occur when the conversation exceeds 5,000 tokens after instructions. This cannot be higher than the model's context window size minus the maximum output tokens.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "minimum": 0 }, - "oasRef": "#/components/schemas/RealtimeTruncation/oneOf/1/properties/token_limits/properties/post_instructions", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) noise_reduction > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", "type": { "kind": "HttpTypeReference", "ident": "NoiseReductionType", "$ref": "(resource) realtime > (model) noise_reduction_type > (schema)" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/noise_reduction/properties/type", - "deprecated": false, - "schemaType": "enum", + "optional": true, + "nullable": false, "modelImplicit": false, + "schemaType": "enum", "modelPath": "(resource) realtime > (model) noise_reduction_type", "childrenParentSchema": "enum", "children": [ @@ -32950,37 +33153,65 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) language": { "kind": "HttpDeclProperty", - "docstring": "The language of the input audio.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", + "deprecated": false, "key": "language", + "docstring": "The language of the input audio.\n", + "type": { + "kind": "HttpTypeString" + }, "optional": true, "nullable": false, + "schemaType": "string", + "children": [] + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) languages": { + "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "deprecated": false, + "key": "languages", + "docstring": "The possible input audio languages configured for transcription, in [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.\n", "type": { + "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/languages", + "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/language", - "deprecated": false, - "schemaType": "string", + "optional": true, + "nullable": false, + "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model": { "kind": "HttpDeclProperty", - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", + "deprecated": false, "key": "model", - "optional": true, - "nullable": false, + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", "types": [ { "kind": "HttpTypeString" }, { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -33001,14 +33232,12 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model" + ] }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -33018,77 +33247,78 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) prompt": { "kind": "HttpDeclProperty", - "docstring": "The prompt configured for input audio transcription, when present.\n", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", + "deprecated": false, "key": "prompt", - "optional": true, - "nullable": false, + "docstring": "The prompt configured for input audio transcription, when present.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/prompt", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms": { "kind": "HttpDeclProperty", - "docstring": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/prefix_padding_ms", + "deprecated": false, "key": "prefix_padding_ms", - "optional": true, - "nullable": false, + "docstring": "Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/prefix_padding_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) silence_duration_ms": { "kind": "HttpDeclProperty", - "docstring": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/silence_duration_ms", + "deprecated": false, "key": "silence_duration_ms", - "optional": true, - "nullable": false, + "docstring": "Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/silence_duration_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) threshold": { "kind": "HttpDeclProperty", - "docstring": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/threshold", + "deprecated": false, "key": "threshold", - "optional": true, - "nullable": false, + "docstring": "Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/threshold", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, only `server_vad` is currently supported.\n", + "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "Type of turn detection, only `server_vad` is currently supported.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeTranscriptionSessionCreateResponseGA/properties/audio/properties/input/properties/turn_detection", + "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "ident": "RealtimeTranscriptionSessionTurnDetection", "type": { "kind": "HttpTypeObject", @@ -33107,7 +33337,6 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "docstring": "Configuration for turn detection. Can be set to `null` to turn off. Server\nVAD means that the model will detect the start and end of speech based on\naudio volume and respond at the end of user speech. For `gpt-realtime-whisper`, this must be `null`; VAD is not supported.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_turn_detection > (schema) > (property) prefix_padding_ms", @@ -33118,22 +33347,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate": { "kind": "HttpDeclProperty", - "docstring": "The sample rate of the audio. Always `24000`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", + "deprecated": false, "key": "rate", - "optional": true, - "nullable": false, + "docstring": "The sample rate of the audio. Always `24000`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", "types": [ { "kind": "HttpTypeLiteral", "literal": 24000 } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/rate", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33142,22 +33371,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcm`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcm`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcm" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/0/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33166,22 +33395,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcmu`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcmu`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcmu" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/1/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33190,22 +33419,22 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 2 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The audio format. Always `audio/pcma`.", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The audio format. Always `audio/pcma`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "audio/pcma" } - ], - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeAudioFormats/anyOf/2/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33229,9 +33458,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime > (model) noise_reduction_type > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/NoiseReductionType", + "docstring": "Type of noise reduction. `near_field` is for close-talking microphones such as headphones, `far_field` is for far-field microphones such as laptop or conference room microphones.\n", "ident": "NoiseReductionType", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/NoiseReductionType", "types": [ { "kind": "HttpTypeLiteral", @@ -33241,10 +33472,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "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", @@ -33263,14 +33492,24 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -33291,10 +33530,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] }, - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", @@ -33302,28 +33539,30 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", - "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7" ] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, - "default": "server_vad", + "docstring": "Type of turn detection, `server_vad` to turn on simple Server VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "server_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/type", - "deprecated": false, + "default": "server_vad", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33332,25 +33571,25 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) create_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs. If `interrupt_response` is set to `false` this may fail to create a response if the model is already responding.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) idle_timeout_ms": { "kind": "HttpDeclProperty", - "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", + "deprecated": false, "key": "idle_timeout_ms", - "optional": true, - "nullable": true, + "docstring": "Optional timeout after which a model response will be triggered automatically. This is\nuseful for situations in which a long pause from the user is unexpected, such as a phone\ncall. The model will effectively prompt the user to continue the conversation based\non the current context.\n\nThe timeout value will be applied after the last model response's audio has finished playing,\ni.e. it's set to the `response.done` time plus audio playback duration.\n\nAn `input_audio_buffer.timeout_triggered` event (plus events\nassociated with the Response) will be emitted when the timeout is reached.\nIdle timeout is currently only supported for `server_vad` mode.\n", "type": { "kind": "HttpTypeNumber" }, @@ -33358,86 +33597,86 @@ Schema name: `RealtimeServerEventSessionUpdated` "minimum": 5000, "maximum": 30000 }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/idle_timeout_ms", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) interrupt_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically interrupt (cancel) any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs. If `true` then the response will be cancelled, otherwise it will continue until complete.\n\nIf both `create_response` and `interrupt_response` are set to `false`, the model will never respond automatically but VAD events will still be emitted.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) prefix_padding_ms": { "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", + "deprecated": false, "key": "prefix_padding_ms", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Amount of audio to include before the VAD detected speech (in\nmilliseconds). Defaults to 300ms.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/prefix_padding_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) silence_duration_ms": { "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", + "deprecated": false, "key": "silence_duration_ms", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Duration of silence to detect speech stop (in milliseconds). Defaults\nto 500ms. With shorter values the model will respond more quickly,\nbut may jump in on short pauses from the user.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/silence_duration_ms", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 0 > (property) threshold": { "kind": "HttpDeclProperty", - "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", + "deprecated": false, "key": "threshold", - "optional": true, - "nullable": false, + "docstring": "Used only for `server_vad` mode. Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A\nhigher threshold will require louder audio to activate the model, and\nthus might perform better in noisy environments.\n", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/0/properties/threshold", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "Type of turn detection, `semantic_vad` to turn on Semantic VAD.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "semantic_vad" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33446,28 +33685,28 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) create_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", + "deprecated": false, "key": "create_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically generate a response when a VAD stop event occurs.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/create_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) eagerness": { "kind": "HttpDeclProperty", - "docstring": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", + "deprecated": false, "key": "eagerness", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "Used only for `semantic_vad` mode. The eagerness of the model to respond. `low` will wait longer for the user to continue speaking, `high` will respond more quickly. `auto` is the default and is equivalent to `medium`. `low`, `medium`, and `high` have max timeouts of 8s, 4s, and 2s respectively.\n", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", "types": [ { "kind": "HttpTypeLiteral", @@ -33485,11 +33724,11 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "auto" } - ], - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness" + ] }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/eagerness", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33501,16 +33740,16 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) turn_detection > (variant) 1 > (property) interrupt_response": { "kind": "HttpDeclProperty", - "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", + "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", + "deprecated": false, "key": "interrupt_response", - "optional": true, - "nullable": false, - "default": true, + "docstring": "Whether or not to automatically interrupt any ongoing response with output to the default\nconversation (i.e. `conversation` of `auto`) when a VAD start event occurs.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeTurnDetection/anyOf/0/oneOf/1/properties/interrupt_response", - "deprecated": false, + "default": true, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, @@ -33593,23 +33832,23 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_text > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33653,23 +33892,23 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_image > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33706,23 +33945,23 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) responses > (model) response_input_file > (schema) > (property) prompt_cache_breakpoint > (property) mode": { "kind": "HttpDeclProperty", - "docstring": "The breakpoint mode. Always `explicit`.", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", + "deprecated": false, "key": "mode", - "optional": false, - "nullable": false, - "default": "explicit", + "docstring": "The breakpoint mode. Always `explicit`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", "types": [ { "kind": "HttpTypeLiteral", "literal": "explicit" } - ], - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode" + ] }, - "oasRef": "#/components/schemas/PromptCacheBreakpointConfig/properties/mode", - "deprecated": false, + "default": "explicit", + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -33731,44 +33970,44 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) read_only": { "kind": "HttpDeclProperty", - "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) allowed_tools > (variant) 1 > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always": { "kind": "HttpDeclProperty", - "title": "MCP tool filter", - "docstring": "A filter object to specify which tools are allowed.\n", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", + "deprecated": false, "key": "always", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -33780,8 +34019,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/always", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -33791,11 +34030,11 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never": { "kind": "HttpDeclProperty", - "title": "MCP tool filter", - "docstring": "A filter object to specify which tools are allowed.\n", + "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", + "deprecated": false, "key": "never", - "optional": true, - "nullable": false, + "docstring": "A filter object to specify which tools are allowed.\n", + "title": "MCP tool filter", "type": { "kind": "HttpTypeObject", "members": [ @@ -33807,8 +34046,8 @@ Schema name: `RealtimeServerEventSessionUpdated` } ] }, - "oasRef": "#/components/schemas/MCPTool/properties/require_approval/anyOf/0/oneOf/0/properties/never", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "object", "childrenParentSchema": "object", "children": [ @@ -33842,14 +34081,24 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", + "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-transcribe`, `gpt-live-transcribe`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "ident": "UnionMember1", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1", "types": [ { "kind": "HttpTypeLiteral", "literal": "whisper-1" }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-transcribe" + }, + { + "kind": "HttpTypeLiteral", + "literal": "gpt-live-transcribe" + }, { "kind": "HttpTypeLiteral", "literal": "gpt-4o-mini-transcribe" @@ -33870,10 +34119,8 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpTypeLiteral", "literal": "gpt-realtime-whisper" } - ], - "oasRef": "#/components/schemas/AudioTranscriptionResponse/properties/model/anyOf/1" + ] }, - "docstring": "The model used for transcription. Current options are `whisper-1`, `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `gpt-4o-transcribe`, `gpt-4o-transcribe-diarize`, and `gpt-realtime-whisper`.\n", "childrenParentSchema": "enum", "children": [ "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 0", @@ -33881,7 +34128,9 @@ Schema name: `RealtimeServerEventSessionUpdated` "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3", "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4", - "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5" + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6", + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7" ] }, "(resource) realtime > (model) realtime_audio_formats > (schema) > (variant) 0 > (property) rate > (member) 0": { @@ -33923,31 +34172,45 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe" + "literal": "gpt-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe-2025-12-15" + "literal": "gpt-live-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe" + "literal": "gpt-4o-mini-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe-diarize" + "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe" + } + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe-diarize" + } + }, + "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -34019,67 +34282,67 @@ Schema name: `RealtimeServerEventSessionUpdated` }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) read_only": { "kind": "HttpDeclProperty", - "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) always > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) read_only": { "kind": "HttpDeclProperty", - "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", + "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", + "deprecated": false, "key": "read_only", - "optional": true, - "nullable": false, + "docstring": "Indicates whether or not a tool modifies data or is read-only. If an\nMCP server is [annotated with `readOnlyHint`](https://modelcontextprotocol.io/specification/2025-06-18/schema#toolannotations-readonlyhint),\nit will match this filter.\n", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/read_only", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime.client_secrets > (model) realtime_session_create_response > (schema) > (property) tools > (items) > (variant) 1 > (property) require_approval > (variant) 0 > (property) never > (property) tool_names": { "kind": "HttpDeclProperty", - "title": "MCP allowed tools", - "docstring": "List of allowed tool names.", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", + "deprecated": false, "key": "tool_names", - "optional": true, - "nullable": false, + "docstring": "List of allowed tool names.", + "title": "MCP allowed tools", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", "elementType": { "kind": "HttpTypeString" + } }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names" - }, - "oasRef": "#/components/schemas/MCPToolFilter/properties/tool_names", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "array", "children": [] }, @@ -34094,31 +34357,45 @@ Schema name: `RealtimeServerEventSessionUpdated` "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe" + "literal": "gpt-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 2": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-mini-transcribe-2025-12-15" + "literal": "gpt-live-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 3": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe" + "literal": "gpt-4o-mini-transcribe" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 4": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", - "literal": "gpt-4o-transcribe-diarize" + "literal": "gpt-4o-mini-transcribe-2025-12-15" } }, "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 5": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe" + } + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 6": { + "kind": "HttpDeclReference", + "type": { + "kind": "HttpTypeLiteral", + "literal": "gpt-4o-transcribe-diarize" + } + }, + "(resource) realtime.client_secrets > (model) realtime_transcription_session_create_response > (schema) > (property) audio > (property) input > (property) transcription > (property) model > (variant) 1 > (member) 7": { "kind": "HttpDeclReference", "type": { "kind": "HttpTypeLiteral", @@ -34225,6 +34502,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 31": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEvent/anyOf/31", + "docstring": "**WebRTC/SIP Only:** Emitted when the server begins streaming audio to the client. This event is\nemitted after an audio content part has been added (`response.content_part.added`)\nto the response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "ident": "OutputAudioBufferStarted", "type": { "kind": "HttpTypeObject", @@ -34240,7 +34518,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "**WebRTC/SIP Only:** Emitted when the server begins streaming audio to the client. This event is\nemitted after an audio content part has been added (`response.content_part.added`)\nto the response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 31 > (property) event_id", @@ -34250,50 +34527,50 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 31 > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 31 > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the response that produced the audio.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the response that produced the audio.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 31 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `output_audio_buffer.started`.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `output_audio_buffer.started`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_audio_buffer.started" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStarted/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34332,6 +34609,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 32": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEvent/anyOf/32", + "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer has been completely drained on the server,\nand no more audio is forthcoming. This event is emitted after the full response\ndata has been sent to the client (`response.done`).\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "ident": "OutputAudioBufferStopped", "type": { "kind": "HttpTypeObject", @@ -34347,7 +34625,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer has been completely drained on the server,\nand no more audio is forthcoming. This event is emitted after the full response\ndata has been sent to the client (`response.done`).\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 32 > (property) event_id", @@ -34357,50 +34634,50 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 32 > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 32 > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the response that produced the audio.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the response that produced the audio.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 32 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `output_audio_buffer.stopped`.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `output_audio_buffer.stopped`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_audio_buffer.stopped" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferStopped/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34440,6 +34717,7 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEvent/anyOf/33", + "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer is cleared. This happens either in VAD\nmode when the user has interrupted (`input_audio_buffer.speech_started`),\nor when the client has emitted the `output_audio_buffer.clear` event to manually\ncut off the current audio response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "ident": "OutputAudioBufferCleared", "type": { "kind": "HttpTypeObject", @@ -34455,7 +34733,6 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( } ] }, - "docstring": "**WebRTC/SIP Only:** Emitted when the output audio buffer is cleared. This happens either in VAD\nmode when the user has interrupted (`input_audio_buffer.speech_started`),\nor when the client has emitted the `output_audio_buffer.clear` event to manually\ncut off the current audio response.\n[Learn more](/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) event_id", @@ -34465,50 +34742,50 @@ Schema name: `(resource) realtime > (model) realtime_server_event > (schema) > ( }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the response that produced the audio.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the response that produced the audio.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_server_event > (schema) > (variant) 33 > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `output_audio_buffer.cleared`.", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `output_audio_buffer.cleared`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "output_audio_buffer.cleared" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventOutputAudioBufferCleared/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34549,6 +34826,7 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) conversation_item_added > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded", + "docstring": "Sent by the server when an Item is added to the default Conversation. This can happen in several cases:\n- When the client sends a `conversation.item.create` event.\n- When the input audio buffer is committed. In this case the item will be a user message containing the audio from the buffer.\n- When the model is generating a Response. In this case the `conversation.item.added` event will be sent when the model starts generating a specific Item, and thus it will not yet have any content (and `status` will be `in_progress`).\n\nThe event will include the full content of the Item (except when model is generating a Response) except for audio data, which can be retrieved separately with a `conversation.item.retrieve` event if necessary.\n", "ident": "ConversationItemAdded", "type": { "kind": "HttpTypeObject", @@ -34567,7 +34845,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "docstring": "Sent by the server when an Item is added to the default Conversation. This can happen in several cases:\n- When the client sends a `conversation.item.create` event.\n- When the input audio buffer is committed. In this case the item will be a user message containing the audio from the buffer.\n- When the model is generating a Response. In this case the `conversation.item.added` event will be sent when the model starts generating a specific Item, and thus it will not yet have any content (and `status` will be `in_progress`).\n\nThe event will include the full content of the Item (except when model is generating a Response) except for audio data, which can be retrieved separately with a `conversation.item.retrieve` event if necessary.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_added > (schema) > (property) event_id", @@ -34578,33 +34855,33 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) conversation_item_added > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_added > (schema) > (property) item": { "kind": "HttpDeclProperty", - "docstring": "A single item within a Realtime conversation.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/item", + "deprecated": false, "key": "item", - "optional": false, - "nullable": false, + "docstring": "A single item within a Realtime conversation.", "type": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/item", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) conversation_item", "childrenParentSchema": "union", "children": [ @@ -34621,22 +34898,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) conversation_item_added > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.added`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.added`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.added" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34645,15 +34922,15 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) conversation_item_added > (schema) > (property) previous_item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item that precedes this one, if any. This is used to\nmaintain ordering when items are inserted.\n", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/previous_item_id", + "deprecated": false, "key": "previous_item_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the item that precedes this one, if any. This is used to\nmaintain ordering when items are inserted.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemAdded/properties/previous_item_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -34812,9 +35089,11 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -34861,10 +35140,8 @@ Schema name: `RealtimeServerEventConversationItemAdded` "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", @@ -34887,12 +35164,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -34903,11 +35181,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -34917,22 +35194,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34941,22 +35218,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -34965,36 +35242,36 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35003,12 +35280,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -35022,11 +35300,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35038,6 +35315,7 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -35062,7 +35340,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "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", @@ -35075,12 +35352,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -35103,11 +35381,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -35121,22 +35398,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35145,22 +35422,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35169,36 +35446,36 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35207,12 +35484,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -35226,11 +35504,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35242,6 +35519,7 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -35266,7 +35544,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -35279,12 +35556,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -35301,11 +35579,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -35317,22 +35594,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35341,22 +35618,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35365,36 +35642,36 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35403,12 +35680,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -35422,11 +35700,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35438,6 +35715,7 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -35462,7 +35740,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -35475,50 +35752,50 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35527,50 +35804,50 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35579,12 +35856,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -35598,11 +35876,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35614,6 +35891,7 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -35641,7 +35919,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -35655,50 +35932,50 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35707,36 +35984,36 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35745,12 +36022,13 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -35764,11 +36042,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35780,6 +36057,7 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -35804,7 +36082,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "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", @@ -35817,64 +36094,64 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -35883,21 +36160,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -35919,7 +36197,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -35931,26 +36208,27 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -35967,11 +36245,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -35983,22 +36260,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36007,21 +36284,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -36040,7 +36318,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "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", @@ -36051,78 +36328,78 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36131,26 +36408,27 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -36167,11 +36445,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -36182,21 +36459,22 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -36227,7 +36505,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "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", @@ -36242,78 +36519,78 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36323,6 +36600,7 @@ Schema name: `RealtimeServerEventConversationItemAdded` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -36344,7 +36622,6 @@ Schema name: `RealtimeServerEventConversationItemAdded` } ] }, - "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", @@ -36356,36 +36633,36 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36436,27 +36713,27 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -36470,11 +36747,11 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36485,57 +36762,58 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -36549,11 +36827,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36606,54 +36883,55 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -36663,11 +36941,10 @@ Schema name: `RealtimeServerEventConversationItemAdded` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -36796,57 +37073,57 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -37048,47 +37325,47 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37097,34 +37374,34 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37133,47 +37410,47 @@ Schema name: `RealtimeServerEventConversationItemAdded` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37241,6 +37518,7 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) conversation_item_done > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone", + "docstring": "Returned when a conversation item is finalized.\n\nThe event will include the full content of the Item except for audio data, which can be retrieved separately with a `conversation.item.retrieve` event if needed.\n", "ident": "ConversationItemDone", "type": { "kind": "HttpTypeObject", @@ -37259,7 +37537,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "docstring": "Returned when a conversation item is finalized.\n\nThe event will include the full content of the Item except for audio data, which can be retrieved separately with a `conversation.item.retrieve` event if needed.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_done > (schema) > (property) event_id", @@ -37270,33 +37547,33 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) conversation_item_done > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_done > (schema) > (property) item": { "kind": "HttpDeclProperty", - "docstring": "A single item within a Realtime conversation.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/item", + "deprecated": false, "key": "item", - "optional": false, - "nullable": false, + "docstring": "A single item within a Realtime conversation.", "type": { "kind": "HttpTypeReference", "ident": "ConversationItem", "$ref": "(resource) realtime > (model) conversation_item > (schema)" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/item", - "deprecated": false, - "schemaType": "union", + "optional": false, + "nullable": false, "modelImplicit": false, + "schemaType": "union", "modelPath": "(resource) realtime > (model) conversation_item", "childrenParentSchema": "union", "children": [ @@ -37313,22 +37590,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) conversation_item_done > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37337,15 +37614,15 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) conversation_item_done > (schema) > (property) previous_item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item that precedes this one, if any. This is used to\nmaintain ordering when items are inserted.\n", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/previous_item_id", + "deprecated": false, "key": "previous_item_id", - "optional": true, - "nullable": true, + "docstring": "The ID of the item that precedes this one, if any. This is used to\nmaintain ordering when items are inserted.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemDone/properties/previous_item_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -37504,9 +37781,11 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) conversation_item > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItem", + "docstring": "A single item within a Realtime conversation.", "ident": "ConversationItem", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItem", "types": [ { "kind": "HttpTypeReference", @@ -37553,10 +37832,8 @@ Schema name: `RealtimeServerEventConversationItemDone` "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", @@ -37579,12 +37856,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -37595,11 +37873,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -37609,22 +37886,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `system`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `system`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "system" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37633,22 +37910,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37657,36 +37934,36 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37695,12 +37972,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -37714,11 +37992,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37730,6 +38007,7 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) realtime_conversation_item_system_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem", + "docstring": "A system message in a Realtime conversation can be used to provide additional context or instructions to the model. This is similar but distinct from the instruction prompt provided at the start of a conversation, as system messages can be added at any point in the conversation. For major changes to the conversation's behavior, use instructions, but for smaller updates (e.g. \"the user is now asking about a different topic\"), use system messages.", "ident": "RealtimeConversationItemSystemMessage", "type": { "kind": "HttpTypeObject", @@ -37754,7 +38032,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "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", @@ -37767,12 +38044,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -37795,11 +38073,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -37813,22 +38090,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `user`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `user`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "user" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37837,22 +38114,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37861,36 +38138,36 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37899,12 +38176,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -37918,11 +38196,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -37934,6 +38211,7 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) realtime_conversation_item_user_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser", + "docstring": "A user message item in a Realtime conversation.", "ident": "RealtimeConversationItemUserMessage", "type": { "kind": "HttpTypeObject", @@ -37958,7 +38236,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "docstring": "A user message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content", @@ -37971,12 +38248,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content": { "kind": "HttpDeclProperty", - "docstring": "The content of the message.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", + "deprecated": false, "key": "content", - "optional": false, - "nullable": false, + "docstring": "The content of the message.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -37993,11 +38271,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "ident": "type" } ] + } }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content" - }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -38009,22 +38286,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) role": { "kind": "HttpDeclProperty", - "docstring": "The role of the message sender. Always `assistant`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", + "deprecated": false, "key": "role", - "optional": false, - "nullable": false, + "docstring": "The role of the message sender. Always `assistant`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", "types": [ { "kind": "HttpTypeLiteral", "literal": "assistant" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/role", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38033,22 +38310,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `message`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `message`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "message" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38057,36 +38334,36 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38095,12 +38372,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -38114,11 +38392,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38130,6 +38407,7 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant", + "docstring": "An assistant message item in a Realtime conversation.", "ident": "RealtimeConversationItemAssistantMessage", "type": { "kind": "HttpTypeObject", @@ -38154,7 +38432,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "docstring": "An assistant message item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content", @@ -38167,50 +38444,50 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The arguments of the function call. This is a JSON-encoded string representing the arguments passed to the function, for example `{\"arg1\": \"value1\", \"arg2\": 42}`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the function being called.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the function being called.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38219,50 +38496,50 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": true, - "nullable": false, + "docstring": "The ID of the function call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/call_id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38271,12 +38548,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -38290,11 +38568,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38306,6 +38583,7 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) realtime_conversation_item_function_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCall", + "docstring": "A function call item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCall", "type": { "kind": "HttpTypeObject", @@ -38333,7 +38611,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "docstring": "A function call item in a Realtime conversation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_conversation_item_function_call > (schema) > (property) arguments", @@ -38347,50 +38624,50 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) call_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the function call this output is for.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", + "deprecated": false, "key": "call_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the function call this output is for.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/call_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", + "deprecated": false, "key": "output", - "optional": false, - "nullable": false, + "docstring": "The output of the function call, this is free text and can contain any information or simply be empty.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/output", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `function_call_output`.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `function_call_output`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "function_call_output" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38399,36 +38676,36 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the item. This may be provided by the client or generated by the server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) object": { "kind": "HttpDeclProperty", - "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", + "deprecated": false, "key": "object", - "optional": true, - "nullable": false, + "docstring": "Identifier for the API object being returned - always `realtime.item`. Optional when creating a new item.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", "types": [ { "kind": "HttpTypeLiteral", "literal": "realtime.item" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/object", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38437,12 +38714,13 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema) > (property) status": { "kind": "HttpDeclProperty", - "docstring": "The status of the item. Has no effect on the conversation.", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", + "deprecated": false, "key": "status", - "optional": true, - "nullable": false, + "docstring": "The status of the item. Has no effect on the conversation.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", "types": [ { "kind": "HttpTypeLiteral", @@ -38456,11 +38734,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput/properties/status", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38472,6 +38749,7 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) realtime_conversation_item_function_call_output > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeConversationItemFunctionCallOutput", + "docstring": "A function call output item in a Realtime conversation.", "ident": "RealtimeConversationItemFunctionCallOutput", "type": { "kind": "HttpTypeObject", @@ -38496,7 +38774,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "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", @@ -38509,64 +38786,64 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval response.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the approval request being answered.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the approval request being answered.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approval_request_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) approve": { "kind": "HttpDeclProperty", - "docstring": "Whether the request was approved.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", + "deprecated": false, "key": "approve", - "optional": false, - "nullable": false, + "docstring": "Whether the request was approved.", "type": { "kind": "HttpTypeBoolean" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/approve", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "boolean", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_response`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_response`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_response" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38575,21 +38852,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) reason": { "kind": "HttpDeclProperty", - "docstring": "Optional reason for the decision.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", + "deprecated": false, "key": "reason", - "optional": true, - "nullable": true, + "docstring": "Optional reason for the decision.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse/properties/reason", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_response > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalResponse", + "docstring": "A Realtime item responding to an MCP approval request.\n", "ident": "RealtimeMcpApprovalResponse", "type": { "kind": "HttpTypeObject", @@ -38611,7 +38889,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "docstring": "A Realtime item responding to an MCP approval request.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) realtime_mcp_approval_response > (schema) > (property) id", @@ -38623,26 +38900,27 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools": { "kind": "HttpDeclProperty", - "docstring": "The tools available on the server.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", + "deprecated": false, "key": "tools", - "optional": false, - "nullable": false, + "docstring": "The tools available on the server.", "type": { "kind": "HttpTypeArray", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", "elementType": { "kind": "HttpTypeObject", "members": [ @@ -38659,11 +38937,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "ident": "description" } ] + } }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools" - }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/tools", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "array", "childrenParentSchema": "object", "children": [ @@ -38675,22 +38952,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_list_tools`.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_list_tools`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools" } - ], - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38699,21 +38976,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the list.", + "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", + "deprecated": false, "key": "id", - "optional": true, - "nullable": false, + "docstring": "The unique ID of the list.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPListTools/properties/id", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPListTools", + "docstring": "A Realtime item listing tools available on an MCP server.\n", "ident": "RealtimeMcpListTools", "type": { "kind": "HttpTypeObject", @@ -38732,7 +39010,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "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", @@ -38743,78 +39020,78 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of the arguments passed to the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of the arguments passed to the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool that was run.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool that was run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server running the tool.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server running the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_call`.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_call`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_call" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -38823,26 +39100,27 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) approval_request_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of an associated approval request, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", + "deprecated": false, "key": "approval_request_id", - "optional": true, - "nullable": true, + "docstring": "The ID of an associated approval request, if any.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/approval_request_id", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) error": { "kind": "HttpDeclProperty", - "docstring": "The error from the tool call, if any.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", + "deprecated": false, "key": "error", - "optional": true, - "nullable": true, + "docstring": "The error from the tool call, if any.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", "types": [ { "kind": "HttpTypeReference", @@ -38859,11 +39137,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "ident": "RealtimeMcphttpError", "$ref": "(resource) realtime > (model) realtime_mcphttp_error > (schema)" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/error", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "union", "childrenParentSchema": "union", "children": [ @@ -38874,21 +39151,22 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema) > (property) output": { "kind": "HttpDeclProperty", - "docstring": "The output from the tool call.", + "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", + "deprecated": false, "key": "output", - "optional": true, - "nullable": true, + "docstring": "The output from the tool call.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolCall/properties/output", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_call > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPToolCall", + "docstring": "A Realtime item representing an invocation of a tool on an MCP server.\n", "ident": "RealtimeMcpToolCall", "type": { "kind": "HttpTypeObject", @@ -38919,7 +39197,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "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", @@ -38934,78 +39211,78 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the approval request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the approval request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "A JSON string of arguments for the tool.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "A JSON string of arguments for the tool.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool to run.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool to run.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) server_label": { "kind": "HttpDeclProperty", - "docstring": "The label of the MCP server making the request.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", + "deprecated": false, "key": "server_label", - "optional": false, - "nullable": false, + "docstring": "The label of the MCP server making the request.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/server_label", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_approval_request > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The type of the item. Always `mcp_approval_request`.", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The type of the item. Always `mcp_approval_request`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_approval_request" } - ], - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39015,6 +39292,7 @@ Schema name: `RealtimeServerEventConversationItemDone` "(resource) realtime > (model) realtime_mcp_approval_request > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeMCPApprovalRequest", + "docstring": "A Realtime item requesting human approval of a tool invocation.\n", "ident": "RealtimeMcpApprovalRequest", "type": { "kind": "HttpTypeObject", @@ -39036,7 +39314,6 @@ Schema name: `RealtimeServerEventConversationItemDone` } ] }, - "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", @@ -39048,36 +39325,36 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_system_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type. Always `input_text` for system messages.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type. Always `input_text` for system messages.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_text" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageSystem/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39128,27 +39405,27 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes (for `input_audio`), these will be parsed as the format specified in the session input audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) detail": { "kind": "HttpDeclProperty", - "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", + "deprecated": false, "key": "detail", - "optional": true, - "nullable": false, - "default": "auto", + "docstring": "The detail level of the image (for `input_image`). `auto` will default to `high`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", "types": [ { "kind": "HttpTypeLiteral", @@ -39162,11 +39439,11 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "high" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/detail", - "deprecated": false, + "default": "auto", + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39177,57 +39454,58 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) image_url": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", + "deprecated": false, "key": "image_url", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded image bytes (for `input_image`) as a data URI. For example `data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...`. Supported formats are PNG and JPEG.", "type": { "kind": "HttpTypeString" }, "constraints": { "format": "uri" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/image_url", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content (for `input_text`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content (for `input_text`).", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "Transcript of the audio (for `input_audio`). This is not sent to the model, but will be attached to the message item for reference.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_user_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type (`input_text`, `input_audio`, or `input_image`).", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -39241,11 +39519,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "input_image" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageUser/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39298,54 +39575,55 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) audio": { "kind": "HttpDeclProperty", - "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", + "deprecated": false, "key": "audio", - "optional": true, - "nullable": false, + "docstring": "Base64-encoded audio bytes, these will be parsed as the format specified in the session output audio type configuration. This defaults to PCM 16-bit 24kHz mono if not specified.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/audio", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text content.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", + "deprecated": false, "key": "text", - "optional": true, - "nullable": false, + "docstring": "The text content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/text", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) transcript": { "kind": "HttpDeclProperty", - "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", + "deprecated": false, "key": "transcript", - "optional": true, - "nullable": false, + "docstring": "The transcript of the audio content, this will always be present if the output type is `audio`.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/transcript", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_conversation_item_assistant_message > (schema) > (property) content > (items) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", + "deprecated": false, "key": "type", - "optional": true, - "nullable": false, + "docstring": "The content type, `output_text` or `output_audio` depending on the session `output_modalities` configuration.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", "types": [ { "kind": "HttpTypeLiteral", @@ -39355,11 +39633,10 @@ Schema name: `RealtimeServerEventConversationItemDone` "kind": "HttpTypeLiteral", "literal": "output_audio" } - ], - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeConversationItemMessageAssistant/properties/content/items/properties/type", - "deprecated": false, + "optional": true, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39488,57 +39765,57 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) input_schema": { "kind": "HttpDeclProperty", - "docstring": "The JSON schema describing the tool's input.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", + "deprecated": false, "key": "input_schema", - "optional": false, - "nullable": false, + "docstring": "The JSON schema describing the tool's input.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/input_schema", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) name": { "kind": "HttpDeclProperty", - "docstring": "The name of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", + "deprecated": false, "key": "name", - "optional": false, - "nullable": false, + "docstring": "The name of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/name", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) annotations": { "kind": "HttpDeclProperty", - "docstring": "Additional annotations about the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", + "deprecated": false, "key": "annotations", - "optional": true, - "nullable": true, + "docstring": "Additional annotations about the tool.\n", "type": { "kind": "HttpTypeUnknown" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/annotations", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "unknown", "children": [] }, "(resource) realtime > (model) realtime_mcp_list_tools > (schema) > (property) tools > (items) > (property) description": { "kind": "HttpDeclProperty", - "docstring": "The description of the tool.\n", + "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", + "deprecated": false, "key": "description", - "optional": true, - "nullable": true, + "docstring": "The description of the tool.\n", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/MCPListToolsTool/properties/description", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -39740,47 +40017,47 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_protocol_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "protocol_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPProtocolError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39789,34 +40066,34 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcp_tool_execution_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "tool_execution_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPToolExecutionError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39825,47 +40102,47 @@ Schema name: `RealtimeServerEventConversationItemDone` }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) code": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", + "deprecated": false, "key": "code", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/code", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) message": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", + "deprecated": false, "key": "message", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/message", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) realtime_mcphttp_error > (schema) > (property) type": { "kind": "HttpDeclProperty", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "http_error" } - ], - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeMCPHTTPError/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -39943,6 +40220,7 @@ Schema name: `RealtimeServerEventInputAudioBufferTimeoutTriggered` "(resource) realtime > (model) input_audio_buffer_timeout_triggered > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered", + "docstring": "Returned when the Server VAD timeout is triggered for the input audio buffer. This is configured\nwith `idle_timeout_ms` in the `turn_detection` settings of the session, and it indicates that\nthere hasn't been any speech detected for the configured duration.\n\nThe `audio_start_ms` and `audio_end_ms` fields indicate the segment of audio after the last\nmodel response up to the triggering time, as an offset from the beginning of audio written\nto the input audio buffer. This means it demarcates the segment of audio that was silent and\nthe difference between the start and end values will roughly match the configured timeout.\n\nThe empty audio will be committed to the conversation as an `input_audio` item (there will be a\n`input_audio_buffer.committed` event) and a model response will be generated. There may be speech\nthat didn't trigger VAD but is still detected by the model, so the model may respond with\nsomething relevant to the conversation or a prompt to continue speaking.\n", "ident": "InputAudioBufferTimeoutTriggered", "type": { "kind": "HttpTypeObject", @@ -39964,7 +40242,6 @@ Schema name: `RealtimeServerEventInputAudioBufferTimeoutTriggered` } ] }, - "docstring": "Returned when the Server VAD timeout is triggered for the input audio buffer. This is configured\nwith `idle_timeout_ms` in the `turn_detection` settings of the session, and it indicates that\nthere hasn't been any speech detected for the configured duration.\n\nThe `audio_start_ms` and `audio_end_ms` fields indicate the segment of audio after the last\nmodel response up to the triggering time, as an offset from the beginning of audio written\nto the input audio buffer. This means it demarcates the segment of audio that was silent and\nthe difference between the start and end values will roughly match the configured timeout.\n\nThe empty audio will be committed to the conversation as an `input_audio` item (there will be a\n`input_audio_buffer.committed` event) and a model response will be generated. There may be speech\nthat didn't trigger VAD but is still detected by the model, so the model may respond with\nsomething relevant to the conversation or a prompt to continue speaking.\n", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) input_audio_buffer_timeout_triggered > (schema) > (property) audio_end_ms", @@ -39976,78 +40253,78 @@ Schema name: `RealtimeServerEventInputAudioBufferTimeoutTriggered` }, "(resource) realtime > (model) input_audio_buffer_timeout_triggered > (schema) > (property) audio_end_ms": { "kind": "HttpDeclProperty", - "docstring": "Millisecond offset of audio written to the input audio buffer at the time the timeout was triggered.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/audio_end_ms", + "deprecated": false, "key": "audio_end_ms", - "optional": false, - "nullable": false, + "docstring": "Millisecond offset of audio written to the input audio buffer at the time the timeout was triggered.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/audio_end_ms", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) input_audio_buffer_timeout_triggered > (schema) > (property) audio_start_ms": { "kind": "HttpDeclProperty", - "docstring": "Millisecond offset of audio written to the input audio buffer that was after the playback time of the last model response.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/audio_start_ms", + "deprecated": false, "key": "audio_start_ms", - "optional": false, - "nullable": false, + "docstring": "Millisecond offset of audio written to the input audio buffer that was after the playback time of the last model response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/audio_start_ms", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) input_audio_buffer_timeout_triggered > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_timeout_triggered > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item associated with this segment.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item associated with this segment.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) input_audio_buffer_timeout_triggered > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `input_audio_buffer.timeout_triggered`.", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `input_audio_buffer.timeout_triggered`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "input_audio_buffer.timeout_triggered" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventInputAudioBufferTimeoutTriggered/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40089,6 +40366,7 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionSegment` "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment", + "docstring": "Returned when an input audio transcription segment is identified for an item.", "ident": "ConversationItemInputAudioTranscriptionSegment", "type": { "kind": "HttpTypeObject", @@ -40122,7 +40400,6 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionSegment` } ] }, - "docstring": "Returned when an input audio transcription segment is identified for an item.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) id", @@ -40138,140 +40415,140 @@ Schema name: `RealtimeServerEventConversationItemInputAudioTranscriptionSegment` }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) id": { "kind": "HttpDeclProperty", - "docstring": "The segment identifier.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/id", + "deprecated": false, "key": "id", - "optional": false, - "nullable": false, + "docstring": "The segment identifier.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) content_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the input audio content part within the item.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/content_index", + "deprecated": false, "key": "content_index", - "optional": false, - "nullable": false, + "docstring": "The index of the input audio content part within the item.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/content_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) end": { "kind": "HttpDeclProperty", - "docstring": "End time of the segment in seconds.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/end", + "deprecated": false, "key": "end", - "optional": false, - "nullable": false, + "docstring": "End time of the segment in seconds.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "double" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/end", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the item containing the input audio content.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the item containing the input audio content.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) speaker": { "kind": "HttpDeclProperty", - "docstring": "The detected speaker label for this segment.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/speaker", + "deprecated": false, "key": "speaker", - "optional": false, - "nullable": false, + "docstring": "The detected speaker label for this segment.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/speaker", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) start": { "kind": "HttpDeclProperty", - "docstring": "Start time of the segment in seconds.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/start", + "deprecated": false, "key": "start", - "optional": false, - "nullable": false, + "docstring": "Start time of the segment in seconds.", "type": { "kind": "HttpTypeNumber" }, "constraints": { "format": "double" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/start", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "number", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) text": { "kind": "HttpDeclProperty", - "docstring": "The text for this segment.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/text", + "deprecated": false, "key": "text", - "optional": false, - "nullable": false, + "docstring": "The text for this segment.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/text", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) conversation_item_input_audio_transcription_segment > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `conversation.item.input_audio_transcription.segment`.", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `conversation.item.input_audio_transcription.segment`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "conversation.item.input_audio_transcription.segment" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventConversationItemInputAudioTranscriptionSegment/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40317,6 +40594,7 @@ Schema name: `RealtimeServerEventMCPListToolsInProgress` "(resource) realtime > (model) mcp_list_tools_in_progress > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress", + "docstring": "Returned when listing MCP tools is in progress for an item.", "ident": "McpListToolsInProgress", "type": { "kind": "HttpTypeObject", @@ -40332,7 +40610,6 @@ Schema name: `RealtimeServerEventMCPListToolsInProgress` } ] }, - "docstring": "Returned when listing MCP tools is in progress for an item.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) mcp_list_tools_in_progress > (schema) > (property) event_id", @@ -40342,50 +40619,50 @@ Schema name: `RealtimeServerEventMCPListToolsInProgress` }, "(resource) realtime > (model) mcp_list_tools_in_progress > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) mcp_list_tools_in_progress > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP list tools item.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP list tools item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) mcp_list_tools_in_progress > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `mcp_list_tools.in_progress`.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `mcp_list_tools.in_progress`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools.in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsInProgress/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40425,6 +40702,7 @@ Schema name: `RealtimeServerEventMCPListToolsCompleted` "(resource) realtime > (model) mcp_list_tools_completed > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted", + "docstring": "Returned when listing MCP tools has completed for an item.", "ident": "McpListToolsCompleted", "type": { "kind": "HttpTypeObject", @@ -40440,7 +40718,6 @@ Schema name: `RealtimeServerEventMCPListToolsCompleted` } ] }, - "docstring": "Returned when listing MCP tools has completed for an item.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) mcp_list_tools_completed > (schema) > (property) event_id", @@ -40450,50 +40727,50 @@ Schema name: `RealtimeServerEventMCPListToolsCompleted` }, "(resource) realtime > (model) mcp_list_tools_completed > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) mcp_list_tools_completed > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP list tools item.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP list tools item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) mcp_list_tools_completed > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `mcp_list_tools.completed`.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `mcp_list_tools.completed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools.completed" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsCompleted/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40533,6 +40810,7 @@ Schema name: `RealtimeServerEventMCPListToolsFailed` "(resource) realtime > (model) mcp_list_tools_failed > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed", + "docstring": "Returned when listing MCP tools has failed for an item.", "ident": "McpListToolsFailed", "type": { "kind": "HttpTypeObject", @@ -40548,7 +40826,6 @@ Schema name: `RealtimeServerEventMCPListToolsFailed` } ] }, - "docstring": "Returned when listing MCP tools has failed for an item.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) mcp_list_tools_failed > (schema) > (property) event_id", @@ -40558,50 +40835,50 @@ Schema name: `RealtimeServerEventMCPListToolsFailed` }, "(resource) realtime > (model) mcp_list_tools_failed > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) mcp_list_tools_failed > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP list tools item.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP list tools item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) mcp_list_tools_failed > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `mcp_list_tools.failed`.", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `mcp_list_tools.failed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "mcp_list_tools.failed" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventMCPListToolsFailed/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40641,6 +40918,7 @@ Schema name: `RealtimeServerEventResponseMCPCallArgumentsDelta` "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta", + "docstring": "Returned when MCP tool call arguments are updated during response generation.", "ident": "ResponseMcpCallArgumentsDelta", "type": { "kind": "HttpTypeObject", @@ -40668,7 +40946,6 @@ Schema name: `RealtimeServerEventResponseMCPCallArgumentsDelta` } ] }, - "docstring": "Returned when MCP tool call arguments are updated during response generation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) delta", @@ -40682,92 +40959,92 @@ Schema name: `RealtimeServerEventResponseMCPCallArgumentsDelta` }, "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) delta": { "kind": "HttpDeclProperty", - "docstring": "The JSON-encoded arguments delta.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/delta", + "deprecated": false, "key": "delta", - "optional": false, - "nullable": false, + "docstring": "The JSON-encoded arguments delta.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/delta", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP tool call item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP tool call item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.mcp_call_arguments.delta`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.mcp_call_arguments.delta`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.mcp_call_arguments.delta" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40776,15 +41053,15 @@ Schema name: `RealtimeServerEventResponseMCPCallArgumentsDelta` }, "(resource) realtime > (model) response_mcp_call_arguments_delta > (schema) > (property) obfuscation": { "kind": "HttpDeclProperty", - "docstring": "If present, indicates the delta text was obfuscated.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/obfuscation", + "deprecated": false, "key": "obfuscation", - "optional": true, - "nullable": true, + "docstring": "If present, indicates the delta text was obfuscated.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDelta/properties/obfuscation", - "deprecated": false, + "optional": true, + "nullable": true, "schemaType": "string", "children": [] }, @@ -40824,6 +41101,7 @@ Schema name: `RealtimeServerEventResponseMCPCallArgumentsDone` "(resource) realtime > (model) response_mcp_call_arguments_done > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone", + "docstring": "Returned when MCP tool call arguments are finalized during response generation.", "ident": "ResponseMcpCallArgumentsDone", "type": { "kind": "HttpTypeObject", @@ -40848,7 +41126,6 @@ Schema name: `RealtimeServerEventResponseMCPCallArgumentsDone` } ] }, - "docstring": "Returned when MCP tool call arguments are finalized during response generation.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_mcp_call_arguments_done > (schema) > (property) arguments", @@ -40861,92 +41138,92 @@ Schema name: `RealtimeServerEventResponseMCPCallArgumentsDone` }, "(resource) realtime > (model) response_mcp_call_arguments_done > (schema) > (property) arguments": { "kind": "HttpDeclProperty", - "docstring": "The final JSON-encoded arguments string.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/arguments", + "deprecated": false, "key": "arguments", - "optional": false, - "nullable": false, + "docstring": "The final JSON-encoded arguments string.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/arguments", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_done > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_done > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP tool call item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP tool call item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_done > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_done > (schema) > (property) response_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/response_id", + "deprecated": false, "key": "response_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the response.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/response_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_arguments_done > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.mcp_call_arguments.done`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.mcp_call_arguments.done`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.mcp_call_arguments.done" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallArgumentsDone/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -40989,6 +41266,7 @@ Schema name: `RealtimeServerEventResponseMCPCallInProgress` "(resource) realtime > (model) response_mcp_call_in_progress > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress", + "docstring": "Returned when an MCP tool call has started and is in progress.", "ident": "ResponseMcpCallInProgress", "type": { "kind": "HttpTypeObject", @@ -41007,7 +41285,6 @@ Schema name: `RealtimeServerEventResponseMCPCallInProgress` } ] }, - "docstring": "Returned when an MCP tool call has started and is in progress.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_mcp_call_in_progress > (schema) > (property) event_id", @@ -41018,64 +41295,64 @@ Schema name: `RealtimeServerEventResponseMCPCallInProgress` }, "(resource) realtime > (model) response_mcp_call_in_progress > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_in_progress > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP tool call item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP tool call item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_in_progress > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_mcp_call_in_progress > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.mcp_call.in_progress`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.mcp_call.in_progress`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.mcp_call.in_progress" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallInProgress/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41116,6 +41393,7 @@ Schema name: `RealtimeServerEventResponseMCPCallCompleted` "(resource) realtime > (model) response_mcp_call_completed > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted", + "docstring": "Returned when an MCP tool call has completed successfully.", "ident": "ResponseMcpCallCompleted", "type": { "kind": "HttpTypeObject", @@ -41134,7 +41412,6 @@ Schema name: `RealtimeServerEventResponseMCPCallCompleted` } ] }, - "docstring": "Returned when an MCP tool call has completed successfully.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_mcp_call_completed > (schema) > (property) event_id", @@ -41145,64 +41422,64 @@ Schema name: `RealtimeServerEventResponseMCPCallCompleted` }, "(resource) realtime > (model) response_mcp_call_completed > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_completed > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP tool call item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP tool call item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_completed > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_mcp_call_completed > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.mcp_call.completed`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.mcp_call.completed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.mcp_call.completed" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallCompleted/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [ @@ -41243,6 +41520,7 @@ Schema name: `RealtimeServerEventResponseMCPCallFailed` "(resource) realtime > (model) response_mcp_call_failed > (schema)": { "kind": "HttpDeclTypeAlias", "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed", + "docstring": "Returned when an MCP tool call has failed.", "ident": "ResponseMcpCallFailed", "type": { "kind": "HttpTypeObject", @@ -41261,7 +41539,6 @@ Schema name: `RealtimeServerEventResponseMCPCallFailed` } ] }, - "docstring": "Returned when an MCP tool call has failed.", "childrenParentSchema": "object", "children": [ "(resource) realtime > (model) response_mcp_call_failed > (schema) > (property) event_id", @@ -41272,64 +41549,64 @@ Schema name: `RealtimeServerEventResponseMCPCallFailed` }, "(resource) realtime > (model) response_mcp_call_failed > (schema) > (property) event_id": { "kind": "HttpDeclProperty", - "docstring": "The unique ID of the server event.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/event_id", + "deprecated": false, "key": "event_id", - "optional": false, - "nullable": false, + "docstring": "The unique ID of the server event.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/event_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_failed > (schema) > (property) item_id": { "kind": "HttpDeclProperty", - "docstring": "The ID of the MCP tool call item.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/item_id", + "deprecated": false, "key": "item_id", - "optional": false, - "nullable": false, + "docstring": "The ID of the MCP tool call item.", "type": { "kind": "HttpTypeString" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/item_id", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "string", "children": [] }, "(resource) realtime > (model) response_mcp_call_failed > (schema) > (property) output_index": { "kind": "HttpDeclProperty", - "docstring": "The index of the output item in the response.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/output_index", + "deprecated": false, "key": "output_index", - "optional": false, - "nullable": false, + "docstring": "The index of the output item in the response.", "type": { "kind": "HttpTypeNumber" }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/output_index", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "integer", "children": [] }, "(resource) realtime > (model) response_mcp_call_failed > (schema) > (property) type": { "kind": "HttpDeclProperty", - "docstring": "The event type, must be `response.mcp_call.failed`.", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/type", + "deprecated": false, "key": "type", - "optional": false, - "nullable": false, + "docstring": "The event type, must be `response.mcp_call.failed`.", "type": { "kind": "HttpTypeUnion", + "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/type", "types": [ { "kind": "HttpTypeLiteral", "literal": "response.mcp_call.failed" } - ], - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/type" + ] }, - "oasRef": "#/components/schemas/RealtimeServerEventResponseMCPCallFailed/properties/type", - "deprecated": false, + "optional": false, + "nullable": false, "schemaType": "enum", "childrenParentSchema": "enum", "children": [