API Data Structures
These definitions are shared by the HTTP API reference
and the downloadable OpenAPI document. Input_ definitions describe accepted
requests; Output_ definitions describe serialized responses. References preserve
recursive types, variants, required fields and nullable values.
Expand a definition to read its complete schema. Protocol field names, enum values and type identifiers remain unchanged across languages.
Input_AccessPrograms
Complete JSON Schema
Referenced structures: Input_CyberAccessProgram
{
"additionalProperties": true,
"description": "Source: upstream_docs/openai/docs/Create a model response.md, access_programs.",
"properties": {
"cyber": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CyberAccessProgram"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_Action
Complete JSON Schema
{
"enum": [
"spawn_agent",
"interrupt_agent",
"list_agents",
"send_message",
"followup_task",
"wait_agent"
],
"type": "string"
}Input_ActivityHandling
Complete JSON Schema
{
"enum": [
"ACTIVITY_HANDLING_UNSPECIFIED",
"START_OF_ACTIVITY_INTERRUPTS",
"NO_INTERRUPTION"
],
"type": "string"
}Input_AdditionalTools
Complete JSON Schema
Referenced structures: Input_AdditionalToolsRole, Input_AdditionalToolsType, Input_Agent, Input_Tool
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"role": {
"$ref": "#/components/schemas/Input_AdditionalToolsRole"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_AdditionalToolsType"
}
},
"required": [
"type",
"role",
"tools"
],
"type": "object"
}Input_AdditionalToolsRole
Complete JSON Schema
{
"enum": [
"developer"
],
"type": "string"
}Input_AdditionalToolsType
Complete JSON Schema
{
"enum": [
"additional_tools"
],
"type": "string"
}Input_AdvisorError
Complete JSON Schema
Referenced structures: Input_AdvisorErrorCode, Input_AdvisorErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Input_AdvisorErrorCode"
},
"type": {
"$ref": "#/components/schemas/Input_AdvisorErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Input_AdvisorErrorCode
Complete JSON Schema
{
"enum": [
"max_uses_exceeded",
"prompt_too_long",
"too_many_requests",
"overloaded",
"unavailable",
"execution_time_exceeded",
"model_not_found"
],
"type": "string"
}Input_AdvisorErrorType
Complete JSON Schema
{
"enum": [
"advisor_tool_result_error"
],
"type": "string"
}Input_AdvisorRedactedResult
Complete JSON Schema
Referenced structures: Input_AdvisorRedactedResultType
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
},
"stop_reason": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_AdvisorRedactedResultType"
}
},
"required": [
"type",
"encrypted_content"
],
"type": "object"
}Input_AdvisorRedactedResultType
Complete JSON Schema
{
"enum": [
"advisor_redacted_result"
],
"type": "string"
}Input_AdvisorResult
Complete JSON Schema
Referenced structures: Input_AdvisorResultType
{
"additionalProperties": true,
"properties": {
"stop_reason": {
"type": [
"string",
"null"
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_AdvisorResultType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_AdvisorResultContent
Complete JSON Schema
Referenced structures: Input_AdvisorError, Input_AdvisorRedactedResult, Input_AdvisorResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_AdvisorError"
},
{
"$ref": "#/components/schemas/Input_AdvisorResult"
},
{
"$ref": "#/components/schemas/Input_AdvisorRedactedResult"
}
]
}Input_AdvisorResultType
Complete JSON Schema
{
"enum": [
"advisor_result"
],
"type": "string"
}Input_AdvisorTool20260301
Complete JSON Schema
Referenced structures: Input_AdvisorTool20260301Name, Input_AdvisorTool20260301Type, Input_AllowedCaller2, Input_CacheControl
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"caching": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"model": {
"type": "string"
},
"name": {
"$ref": "#/components/schemas/Input_AdvisorTool20260301Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_AdvisorTool20260301Type"
}
},
"required": [
"name",
"type",
"model"
],
"type": "object"
}Input_AdvisorTool20260301Name
Complete JSON Schema
{
"enum": [
"advisor"
],
"type": "string"
}Input_AdvisorTool20260301Type
Complete JSON Schema
{
"enum": [
"advisor_20260301"
],
"type": "string"
}Input_AdvisorToolResultBlock
Complete JSON Schema
Referenced structures: Input_AdvisorResultContent, Input_AdvisorToolResultType, Input_CacheControl
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_AdvisorResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_AdvisorToolResultType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Input_AdvisorToolResultType
Complete JSON Schema
{
"enum": [
"advisor_tool_result"
],
"type": "string"
}Input_Agent
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"agent_name": {
"type": "string"
}
},
"required": [
"agent_name"
],
"type": "object"
}Input_AgentContent
Complete JSON Schema
Referenced structures: Input_AgentText, Input_ComputerScreenshot, Input_EncryptedContent, Input_ReasoningContent, Input_ReplayOutputText, Input_ResponseInputFile, Input_ResponseInputImage, Input_ResponseInputText, Input_ResponseOutputRefusal, Input_SummaryText
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInputText"
},
{
"$ref": "#/components/schemas/Input_ReplayOutputText"
},
{
"$ref": "#/components/schemas/Input_AgentText"
},
{
"$ref": "#/components/schemas/Input_SummaryText"
},
{
"$ref": "#/components/schemas/Input_ReasoningContent"
},
{
"$ref": "#/components/schemas/Input_ResponseOutputRefusal"
},
{
"$ref": "#/components/schemas/Input_ResponseInputImage"
},
{
"$ref": "#/components/schemas/Input_ComputerScreenshot"
},
{
"$ref": "#/components/schemas/Input_ResponseInputFile"
},
{
"$ref": "#/components/schemas/Input_EncryptedContent"
}
]
}Input_AgentMessage
Complete JSON Schema
Referenced structures: Input_Agent, Input_AgentContent, Input_AgentMessageType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"author": {
"type": "string"
},
"content": {
"items": {
"$ref": "#/components/schemas/Input_AgentContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"recipient": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_AgentMessageType"
}
},
"required": [
"type",
"author",
"recipient",
"content"
],
"type": "object"
}Input_AgentMessageInputContent
Complete JSON Schema
Referenced structures: Input_AgentMessageInputContentEncryptedContent, Input_AgentMessageInputContentInputText
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_AgentMessageInputContentInputText",
"properties": {
"type": {
"const": "input_text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_AgentMessageInputContentEncryptedContent",
"properties": {
"type": {
"const": "encrypted_content",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_AgentMessageInputContentEncryptedContent
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
}
},
"required": [
"encrypted_content"
],
"type": "object"
}Input_AgentMessageInputContentInputText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_AgentMessageType
Complete JSON Schema
{
"enum": [
"agent_message"
],
"type": "string"
}Input_AgentText
Complete JSON Schema
Referenced structures: Input_AgentTextType
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_AgentTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_AgentTextType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Input_AllStringThinkingTurns
Complete JSON Schema
{
"enum": [
"all"
],
"type": "string"
}Input_AllThinkingTurns
Complete JSON Schema
Referenced structures: Input_AllThinkingType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_AllThinkingType"
}
},
"required": [
"type"
],
"type": "object"
}Input_AllThinkingType
Complete JSON Schema
{
"enum": [
"all"
],
"type": "string"
}Input_AllowedCaller
Complete JSON Schema
{
"enum": [
"direct",
"programmatic"
],
"type": "string"
}Input_AllowedCaller2
Complete JSON Schema
{
"enum": [
"direct",
"code_execution_20250825",
"code_execution_20260120",
"code_execution_20260521"
],
"type": "string"
}Input_AllowedCaller3
Complete JSON Schema
{
"enum": [
"direct",
"shell",
"code_interpreter"
],
"type": "string"
}Input_AllowedToolChoice
Complete JSON Schema
Referenced structures: Input_AllowedToolChoiceType, Input_AllowedTools
{
"additionalProperties": true,
"properties": {
"allowed_tools": {
"$ref": "#/components/schemas/Input_AllowedTools"
},
"type": {
"$ref": "#/components/schemas/Input_AllowedToolChoiceType"
}
},
"required": [
"type",
"allowed_tools"
],
"type": "object"
}Input_AllowedToolChoiceMode
Complete JSON Schema
{
"enum": [
"auto",
"required"
],
"type": "string"
}Input_AllowedToolChoiceType
Complete JSON Schema
{
"enum": [
"allowed_tools"
],
"type": "string"
}Input_AllowedTools
Complete JSON Schema
Referenced structures: Input_AllowedToolsMode
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_AllowedToolsMode"
},
"tools": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
}
},
"required": [
"mode",
"tools"
],
"type": "object"
}Input_AllowedToolsMode
Complete JSON Schema
{
"enum": [
"auto",
"required"
],
"type": "string"
}Input_AllowlistBody
Complete JSON Schema
{
"properties": {
"clients": {
"description": "`null` clears the per-user allowlist and falls back to the global one.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_ApiKeyBudgetWrite
Complete JSON Schema
{
"description": "A key's initial cost budget. Ownership and metric are assigned by the server.",
"properties": {
"anchorAtMs": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"limitValue": {
"type": "string"
},
"modelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"period": {
"default": null,
"type": [
"string",
"null"
]
},
"periodSeconds": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"windowKey": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"limitValue"
],
"type": "object"
}Input_ApiKeyPatch
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"expiresAtMs": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"management": {
"default": null,
"type": [
"boolean",
"null"
]
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"organizationId": {
"default": null,
"type": [
"string",
"null"
]
},
"teamId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ApiKeyWrite
Complete JSON Schema
Referenced structures: Input_ApiKeyBudgetWrite
{
"properties": {
"budget": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ApiKeyBudgetWrite"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional initial cost budget, committed atomically with the key."
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"expiresAtMs": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"management": {
"default": null,
"description": "Let the key manage: `/admin/api`, and the portal's key and password\noperations. Off by default.",
"type": [
"boolean",
"null"
]
},
"name": {
"type": "string"
},
"organizationId": {
"default": null,
"description": "The binding that decides the budget chain, the permission subject and\nthe credential-visibility boundary at once. It is set here, once, and\nnever taken from a request header.",
"type": [
"string",
"null"
]
},
"retainSecret": {
"default": null,
"description": "Keep a sealed copy of the key text so it can be revealed later. False\nby default: a key the instance cannot reproduce is a key a database\nleak does not hand over.",
"type": [
"boolean",
"null"
]
},
"teamId": {
"default": null,
"type": [
"string",
"null"
]
},
"userId": {
"type": "string"
}
},
"required": [
"userId",
"name"
],
"type": "object"
}Input_ApplyDefaultPricesRequest
Complete JSON Schema
{
"properties": {
"modelIds": {
"description": "Catalog `model_id`s, or names a catalog glob covers.",
"items": {
"type": "string"
},
"type": "array"
},
"overwrite": {
"default": false,
"description": "Whether a rule that already covers the same pattern in the same scope\nis replaced. False leaves an operator's edited price alone, which is\nwhat makes re-applying the catalog safe.",
"type": "boolean"
},
"providerId": {
"default": null,
"description": "None writes global rules, which price the model at every provider. A\nprovider id writes rules that only that provider's traffic matches, and\nthose are written under the literal model id rather than the catalog's\nglob.",
"type": [
"string",
"null"
]
}
},
"required": [
"modelIds"
],
"type": "object"
}Input_ApplyDiscoveredBody
Complete JSON Schema
{
"properties": {
"providerId": {
"type": "string"
},
"upstreamNames": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"providerId"
],
"type": "object"
}Input_ApplyPatchCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_ApplyPatchCallType, Input_ApplyPatchOperation, Input_ApplyPatchStatus, Input_Caller
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"operation": {
"$ref": "#/components/schemas/Input_ApplyPatchOperation"
},
"status": {
"$ref": "#/components/schemas/Input_ApplyPatchStatus"
},
"type": {
"$ref": "#/components/schemas/Input_ApplyPatchCallType"
}
},
"required": [
"type",
"call_id",
"operation",
"status"
],
"type": "object"
}Input_ApplyPatchCallOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_ApplyPatchCallOutputType, Input_ApplyPatchOutputStatus, Input_Caller
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Input_ApplyPatchOutputStatus"
},
"type": {
"$ref": "#/components/schemas/Input_ApplyPatchCallOutputType"
}
},
"required": [
"type",
"call_id",
"status"
],
"type": "object"
}Input_ApplyPatchCallOutputType
Complete JSON Schema
{
"enum": [
"apply_patch_call_output"
],
"type": "string"
}Input_ApplyPatchCallType
Complete JSON Schema
{
"enum": [
"apply_patch_call"
],
"type": "string"
}Input_ApplyPatchCreate
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"diff": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"path",
"diff"
],
"type": "object"
}Input_ApplyPatchDelete
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}Input_ApplyPatchOperation
Complete JSON Schema
Referenced structures: Input_ApplyPatchCreate, Input_ApplyPatchDelete, Input_ApplyPatchUpdate
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ApplyPatchCreate",
"properties": {
"type": {
"const": "create_file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ApplyPatchDelete",
"properties": {
"type": {
"const": "delete_file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ApplyPatchUpdate",
"properties": {
"type": {
"const": "update_file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ApplyPatchOutputStatus
Complete JSON Schema
{
"enum": [
"completed",
"failed"
],
"type": "string"
}Input_ApplyPatchStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed"
],
"type": "string"
}Input_ApplyPatchTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_ApplyPatchUpdate
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"diff": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"path",
"diff"
],
"type": "object"
}Input_ApproximateLocation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"region": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ApproximateLocation2
Complete JSON Schema
Referenced structures: Input_LocationType
{
"additionalProperties": true,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"region": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_LocationType"
}
},
"required": [
"type"
],
"type": "object"
}Input_AspectRatio
Complete JSON Schema
{
"enum": [
"ASPECT_RATIO_UNSPECIFIED",
"ASPECT_RATIO_ONE_BY_ONE",
"ASPECT_RATIO_TWO_BY_THREE",
"ASPECT_RATIO_THREE_BY_TWO",
"ASPECT_RATIO_THREE_BY_FOUR",
"ASPECT_RATIO_FOUR_BY_THREE",
"ASPECT_RATIO_FOUR_BY_FIVE",
"ASPECT_RATIO_FIVE_BY_FOUR",
"ASPECT_RATIO_NINE_BY_SIXTEEN",
"ASPECT_RATIO_SIXTEEN_BY_NINE",
"ASPECT_RATIO_TWENTY_ONE_BY_NINE",
"ASPECT_RATIO_ONE_BY_EIGHT",
"ASPECT_RATIO_EIGHT_BY_ONE",
"ASPECT_RATIO_ONE_BY_FOUR",
"ASPECT_RATIO_FOUR_BY_ONE"
],
"type": "string"
}Input_AssistantAudio
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Input_AssistantContentPart
Complete JSON Schema
Referenced structures: Input_RefusalPart, Input_TextPart
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextPart"
},
{
"$ref": "#/components/schemas/Input_RefusalPart"
}
]
}Input_AssistantContentParts
Complete JSON Schema
Referenced structures: Input_AssistantContentPart
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_AssistantContentPart"
},
"type": "array"
}
]
}Input_AssistantMessage
Complete JSON Schema
Referenced structures: Input_AssistantAudio, Input_AssistantContentParts, Input_AssistantRole, Input_FunctionCall3, Input_MessageToolCall, Input_ReasoningDetail
{
"additionalProperties": true,
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AssistantAudio"
},
{
"type": "null"
}
]
},
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AssistantContentParts"
},
{
"type": "null"
}
]
},
"function_call": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionCall3"
},
{
"type": "null"
}
]
},
"name": {
"type": [
"string",
"null"
]
},
"reasoning": {
"description": "Alternative compatible-provider spelling. Kept separately on the wire.",
"type": [
"string",
"null"
]
},
"reasoning_content": {
"description": "Plain-text reasoning returned by compatible providers (for example DeepSeek).",
"type": [
"string",
"null"
]
},
"reasoning_details": {
"items": {
"$ref": "#/components/schemas/Input_ReasoningDetail"
},
"type": [
"array",
"null"
]
},
"refusal": {
"type": [
"string",
"null"
]
},
"role": {
"$ref": "#/components/schemas/Input_AssistantRole"
},
"tool_calls": {
"items": {
"$ref": "#/components/schemas/Input_MessageToolCall"
},
"type": [
"array",
"null"
]
}
},
"required": [
"role"
],
"type": "object"
}Input_AssistantRole
Complete JSON Schema
{
"enum": [
"assistant"
],
"type": "string"
}Input_AudioFormat
Complete JSON Schema
{
"enum": [
"wav",
"mp3"
],
"type": "string"
}Input_AudioMimeType
Complete JSON Schema
{
"enum": [
"MIME_TYPE_UNSPECIFIED",
"AUDIO_MP3",
"AUDIO_OGG_OPUS",
"AUDIO_L16",
"AUDIO_WAV",
"AUDIO_ALAW",
"AUDIO_MULAW"
],
"type": "string"
}Input_AudioResponseFormat
Complete JSON Schema
Referenced structures: Input_AudioMimeType, Input_Delivery
{
"additionalProperties": true,
"properties": {
"bitRate": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"delivery": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Delivery"
},
{
"type": "null"
}
]
},
"mimeType": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioMimeType"
},
{
"type": "null"
}
]
},
"sampleRate": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_AudioResponseFormat2
Complete JSON Schema
{
"enum": [
"mp3",
"opus",
"aac",
"flac",
"wav",
"pcm"
],
"type": "string"
}Input_AudioTranscription
Complete JSON Schema
Referenced structures: Input_WordInfo
{
"additionalProperties": true,
"properties": {
"speakerLabel": {
"type": [
"string",
"null"
]
},
"text": {
"type": "string"
},
"words": {
"items": {
"$ref": "#/components/schemas/Input_WordInfo"
},
"type": [
"array",
"null"
]
}
},
"required": [
"text"
],
"type": "object"
}Input_AudioTranscription2
Complete JSON Schema
Referenced structures: Input_AudioTranscriptionDelay
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/audio_transcription.py`, `AudioTranscription`.",
"properties": {
"delay": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscriptionDelay"
},
{
"type": "null"
}
]
},
"keywords": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"languages": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"prompt": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_AudioTranscriptionConfig
Complete JSON Schema
Referenced structures: Input_AudioTranscriptionMode, Input_LanguageAuto, Input_LanguageHints
{
"additionalProperties": true,
"properties": {
"adaptationPhrases": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"customVocabulary": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"diarization": {
"type": [
"boolean",
"null"
]
},
"languageAuto": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LanguageAuto"
},
{
"type": "null"
}
]
},
"languageCodes": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"languageHints": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LanguageHints"
},
{
"type": "null"
}
]
},
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscriptionMode"
},
{
"type": "null"
}
]
},
"wordTimestamp": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_AudioTranscriptionDelay
Complete JSON Schema
{
"enum": [
"minimal",
"low",
"medium",
"high",
"xhigh"
],
"type": "string"
}Input_AudioTranscriptionMode
Complete JSON Schema
{
"enum": [
"MODE_UNSPECIFIED",
"VERBATIM",
"SMART"
],
"type": "string"
}Input_AudioVoice
Complete JSON Schema
Referenced structures: Input_AudioVoiceName, Input_CustomVoice
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioVoiceName"
},
{
"$ref": "#/components/schemas/Input_CustomVoice"
},
{
"type": "string"
}
]
}Input_AudioVoiceName
Complete JSON Schema
{
"enum": [
"alloy",
"ash",
"ballad",
"coral",
"echo",
"fable",
"nova",
"onyx",
"sage",
"shimmer",
"verse",
"marin",
"cedar"
],
"type": "string"
}Input_AuthCodeComplete
Complete JSON Schema
{
"description": "Finish a browser redirect login, with either the whole callback URL or the\nauthorization code picked out of it — never both.",
"properties": {
"callbackUrl": {
"default": null,
"description": "The callback as the browser received it; `code` and `state` are read\nout of its query.",
"type": [
"string",
"null"
]
},
"code": {
"default": null,
"description": "The bare authorization code, for a caller that already parsed it.",
"type": [
"string",
"null"
]
},
"loginSessionId": {
"type": "string"
},
"state": {
"default": null,
"description": "The state that came back with a bare code. Absent skips the comparison;\npresent and different is refused.",
"type": [
"string",
"null"
]
}
},
"required": [
"loginSessionId"
],
"type": "object"
}Input_AuthCodeStart
Complete JSON Schema
Referenced structures: Input_CredentialOwner
{
"description": "Begin a browser redirect login. The SDK mints the PKCE verifier and the\nCSRF state itself, so neither is a field here.",
"properties": {
"label": {
"default": null,
"description": "The label for the credential this login will create. Absent derives one\nfrom the channel and whatever account the upstream names.",
"type": [
"string",
"null"
]
},
"owner": {
"$ref": "#/components/schemas/Input_CredentialOwner",
"default": {
"organizationId": null,
"teamId": null,
"userId": null
}
},
"providerId": {
"type": "string"
},
"redirectUri": {
"default": null,
"description": "Where the upstream should send the person back. Absent lets the channel\nuse the redirect it registered with the upstream itself, which is what\na CLI-shaped channel needs.",
"type": [
"string",
"null"
]
}
},
"required": [
"providerId"
],
"type": "object"
}Input_AutoContainerType
Complete JSON Schema
{
"enum": [
"auto"
],
"type": "string"
}Input_AutomaticActivityDetection
Complete JSON Schema
Referenced structures: Input_EndSensitivity, Input_StartSensitivity
{
"additionalProperties": true,
"properties": {
"disabled": {
"type": [
"boolean",
"null"
]
},
"endOfSpeechSensitivity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_EndSensitivity"
},
{
"type": "null"
}
]
},
"prefixPaddingMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silenceDurationMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"startOfSpeechSensitivity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_StartSensitivity"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_AutomaticChunking
Complete JSON Schema
{
"enum": [
"auto"
],
"type": "string"
}Input_AvatarConfig
Complete JSON Schema
Referenced structures: Input_CustomizedAvatar
{
"additionalProperties": true,
"properties": {
"audioBitrateBps": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"avatarName": {
"type": [
"string",
"null"
]
},
"customizedAvatar": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CustomizedAvatar"
},
{
"type": "null"
}
]
},
"videoBitrateBps": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_Base64Source
Complete JSON Schema
Referenced structures: Input_ImageMediaType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"media_type": {
"$ref": "#/components/schemas/Input_ImageMediaType"
}
},
"required": [
"data",
"media_type"
],
"type": "object"
}Input_Base64SourceType
Complete JSON Schema
{
"enum": [
"base64"
],
"type": "string"
}Input_BashCodeExecutionError
Complete JSON Schema
Referenced structures: Input_BashCodeExecutionErrorCode, Input_BashCodeExecutionErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Input_BashCodeExecutionErrorCode"
},
"type": {
"$ref": "#/components/schemas/Input_BashCodeExecutionErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Input_BashCodeExecutionErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded",
"output_file_too_large"
],
"type": "string"
}Input_BashCodeExecutionErrorType
Complete JSON Schema
{
"enum": [
"bash_code_execution_tool_result_error"
],
"type": "string"
}Input_BashCodeExecutionOutput
Complete JSON Schema
Referenced structures: Input_BashCodeExecutionOutputType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_BashCodeExecutionOutputType"
}
},
"required": [
"type",
"file_id"
],
"type": "object"
}Input_BashCodeExecutionOutputType
Complete JSON Schema
{
"enum": [
"bash_code_execution_output"
],
"type": "string"
}Input_BashCodeExecutionResult
Complete JSON Schema
Referenced structures: Input_BashCodeExecutionOutput, Input_BashCodeExecutionResultType
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_BashCodeExecutionOutput"
},
"type": "array"
},
"return_code": {
"format": "int64",
"type": "integer"
},
"stderr": {
"type": "string"
},
"stdout": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_BashCodeExecutionResultType"
}
},
"required": [
"type",
"content",
"return_code",
"stderr",
"stdout"
],
"type": "object"
}Input_BashCodeExecutionResultContent
Complete JSON Schema
Referenced structures: Input_BashCodeExecutionError, Input_BashCodeExecutionResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_BashCodeExecutionError"
},
{
"$ref": "#/components/schemas/Input_BashCodeExecutionResult"
}
]
}Input_BashCodeExecutionResultType
Complete JSON Schema
{
"enum": [
"bash_code_execution_result"
],
"type": "string"
}Input_BashCodeExecutionToolResultBlock
Complete JSON Schema
Referenced structures: Input_BashCodeExecutionResultContent, Input_BashCodeExecutionToolResultType, Input_CacheControl
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_BashCodeExecutionResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_BashCodeExecutionToolResultType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Input_BashCodeExecutionToolResultType
Complete JSON Schema
{
"enum": [
"bash_code_execution_tool_result"
],
"type": "string"
}Input_BashTool20241022
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_BashTool20241022Name, Input_BashTool20241022Type, Input_CacheControl
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_BashTool20241022Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_BashTool20241022Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_BashTool20241022Name
Complete JSON Schema
{
"enum": [
"bash"
],
"type": "string"
}Input_BashTool20241022Type
Complete JSON Schema
{
"enum": [
"bash_20241022"
],
"type": "string"
}Input_BashTool20250124
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_BashTool20250124Name, Input_BashTool20250124Type, Input_CacheControl
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_BashTool20250124Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_BashTool20250124Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_BashTool20250124Name
Complete JSON Schema
{
"enum": [
"bash"
],
"type": "string"
}Input_BashTool20250124Type
Complete JSON Schema
{
"enum": [
"bash_20250124"
],
"type": "string"
}Input_BatchEmbedContentRequest
Complete JSON Schema
Referenced structures: Input_Content, Input_EmbedContentConfig, Input_GeminiTaskType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_Content"
},
"embedContentConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_EmbedContentConfig"
},
{
"type": "null"
}
]
},
"model": {
"type": "string"
},
"outputDimensionality": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"taskType": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GeminiTaskType"
},
{
"type": "null"
}
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"required": [
"model",
"content"
],
"type": "object"
}Input_BatchEmbedContentsRequestBody
Complete JSON Schema
Referenced structures: Input_BatchEmbedContentRequest
{
"additionalProperties": true,
"properties": {
"requests": {
"items": {
"$ref": "#/components/schemas/Input_BatchEmbedContentRequest"
},
"type": "array"
}
},
"required": [
"requests"
],
"type": "object"
}Input_BatchItem
Complete JSON Schema
Referenced structures: Input_BatchPatch, Input_UserWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_UserWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem10
Complete JSON Schema
Referenced structures: Input_BatchPatch10, Input_ModelWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_ModelWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch10"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem11
Complete JSON Schema
Referenced structures: Input_BatchPatch11, Input_ProviderModelWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_ProviderModelWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch11"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem12
Complete JSON Schema
Referenced structures: Input_BatchPatch12, Input_RouteWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_RouteWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch12"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem13
Complete JSON Schema
Referenced structures: Input_BatchPatch13, Input_RouteMemberWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_RouteMemberWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch13"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem14
Complete JSON Schema
Referenced structures: Input_BatchPatch14, Input_ConnectionProfileWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_ConnectionProfileWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch14"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem15
Complete JSON Schema
Referenced structures: Input_BatchPatch15, Input_RuleSetWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_RuleSetWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch15"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem16
Complete JSON Schema
Referenced structures: Input_BatchPatch16, Input_RewriteRuleWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_RewriteRuleWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch16"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem17
Complete JSON Schema
Referenced structures: Input_BatchPatch17, Input_ProviderRuleSetWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_ProviderRuleSetWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch17"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem18
Complete JSON Schema
Referenced structures: Input_BatchPatch18, Input_OperationRuleWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_OperationRuleWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch18"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem19
Complete JSON Schema
Referenced structures: Input_BatchPatch19, Input_OperationEndpointWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_OperationEndpointWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch19"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem2
Complete JSON Schema
Referenced structures: Input_ApiKeyWrite, Input_BatchPatch2
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_ApiKeyWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch2"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem20
Complete JSON Schema
Referenced structures: Input_BatchPatch20, Input_QuotaWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_QuotaWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch20"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem21
Complete JSON Schema
Referenced structures: Input_BatchPatch21, Input_PriceRuleWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_PriceRuleWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch21"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem22
Complete JSON Schema
Referenced structures: Input_BatchPatch22, Input_PriceRateWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_PriceRateWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch22"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem23
Complete JSON Schema
Referenced structures: Input_BatchPatch23, Input_PriceTierWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_PriceTierWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch23"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem3
Complete JSON Schema
Referenced structures: Input_BatchPatch3, Input_OrganizationWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_OrganizationWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch3"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem4
Complete JSON Schema
Referenced structures: Input_BatchPatch4, Input_TeamWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_TeamWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch4"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem5
Complete JSON Schema
Referenced structures: Input_BatchPatch5, Input_PermissionWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_PermissionWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch5"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem6
Complete JSON Schema
Referenced structures: Input_BatchPatch6, Input_RateLimitWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_RateLimitWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch6"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem7
Complete JSON Schema
Referenced structures: Input_BatchPatch7, Input_OAuthClientWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_OAuthClientWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch7"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem8
Complete JSON Schema
Referenced structures: Input_BatchPatch8, Input_ProviderWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_ProviderWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch8"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchItem9
Complete JSON Schema
Referenced structures: Input_BatchPatch9, Input_CredentialWrite
{
"description": "One step of a batch write. Every item of one batch lands in a single\nrevision commit: either all of them are durable or none is.",
"oneOf": [
{
"additionalProperties": false,
"properties": {
"create": {
"$ref": "#/components/schemas/Input_CredentialWrite"
}
},
"required": [
"create"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"update": {
"$ref": "#/components/schemas/Input_BatchPatch9"
}
},
"required": [
"update"
],
"type": "object"
},
{
"additionalProperties": false,
"properties": {
"delete": {
"type": "string"
}
},
"required": [
"delete"
],
"type": "object"
}
]
}Input_BatchPatch
Complete JSON Schema
Referenced structures: Input_UserPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_UserPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch10
Complete JSON Schema
Referenced structures: Input_ModelPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_ModelPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch11
Complete JSON Schema
Referenced structures: Input_ProviderModelPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_ProviderModelPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch12
Complete JSON Schema
Referenced structures: Input_RoutePatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_RoutePatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch13
Complete JSON Schema
Referenced structures: Input_RouteMemberPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_RouteMemberPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch14
Complete JSON Schema
Referenced structures: Input_ConnectionProfilePatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_ConnectionProfilePatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch15
Complete JSON Schema
Referenced structures: Input_RuleSetPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_RuleSetPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch16
Complete JSON Schema
Referenced structures: Input_RewriteRulePatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_RewriteRulePatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch17
Complete JSON Schema
Referenced structures: Input_ProviderRuleSetPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_ProviderRuleSetPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch18
Complete JSON Schema
Referenced structures: Input_OperationRulePatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_OperationRulePatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch19
Complete JSON Schema
Referenced structures: Input_OperationEndpointPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_OperationEndpointPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch2
Complete JSON Schema
Referenced structures: Input_ApiKeyPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_ApiKeyPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch20
Complete JSON Schema
Referenced structures: Input_QuotaPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_QuotaPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch21
Complete JSON Schema
Referenced structures: Input_PriceRulePatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_PriceRulePatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch22
Complete JSON Schema
Referenced structures: Input_PriceRatePatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_PriceRatePatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch23
Complete JSON Schema
Referenced structures: Input_PriceTierPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_PriceTierPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch3
Complete JSON Schema
Referenced structures: Input_OrganizationPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_OrganizationPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch4
Complete JSON Schema
Referenced structures: Input_TeamPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_TeamPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch5
Complete JSON Schema
Referenced structures: Input_PermissionPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_PermissionPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch6
Complete JSON Schema
Referenced structures: Input_RateLimitPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_RateLimitPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch7
Complete JSON Schema
Referenced structures: Input_OAuthClientPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_OAuthClientPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch8
Complete JSON Schema
Referenced structures: Input_ProviderPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_ProviderPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_BatchPatch9
Complete JSON Schema
Referenced structures: Input_CredentialPatch
{
"properties": {
"id": {
"type": "string"
},
"patch": {
"$ref": "#/components/schemas/Input_CredentialPatch"
}
},
"required": [
"id",
"patch"
],
"type": "object"
}Input_Behavior
Complete JSON Schema
{
"enum": [
"UNSPECIFIED",
"BLOCKING",
"NON_BLOCKING"
],
"type": "string"
}Input_BidiGenerateContentClientContent
Complete JSON Schema
Referenced structures: Input_LiveContent
{
"additionalProperties": true,
"properties": {
"turnComplete": {
"type": [
"boolean",
"null"
]
},
"turns": {
"items": {
"$ref": "#/components/schemas/Input_LiveContent"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_BidiGenerateContentRealtimeInput
Complete JSON Schema
Referenced structures: Input_GenerationMediaResolution, Input_LiveActivityEnd, Input_LiveActivityStart, Input_LiveBlob
{
"additionalProperties": true,
"properties": {
"activityEnd": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveActivityEnd"
},
{
"type": "null"
}
]
},
"activityStart": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveActivityStart"
},
{
"type": "null"
}
]
},
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveBlob"
},
{
"type": "null"
}
]
},
"audioStreamEnd": {
"type": [
"boolean",
"null"
]
},
"mediaChunks": {
"items": {
"$ref": "#/components/schemas/Input_LiveBlob"
},
"type": [
"array",
"null"
]
},
"mediaResolution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GenerationMediaResolution"
},
{
"type": "null"
}
]
},
"text": {
"type": [
"string",
"null"
]
},
"video": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveBlob"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_BidiGenerateContentSetup
Complete JSON Schema
Referenced structures: Input_AudioTranscriptionConfig, Input_AvatarConfig, Input_ContextWindowCompressionConfig, Input_HistoryConfig, Input_LiveContent, Input_LiveGenerationConfig, Input_ProactivityConfig, Input_RealtimeInputConfig, Input_SafetySetting, Input_SessionResumptionConfig, Input_Tool3
{
"additionalProperties": true,
"properties": {
"avatarConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AvatarConfig"
},
{
"type": "null"
}
]
},
"contextWindowCompression": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ContextWindowCompressionConfig"
},
{
"type": "null"
}
]
},
"generationConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveGenerationConfig"
},
{
"type": "null"
}
]
},
"historyConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_HistoryConfig"
},
{
"type": "null"
}
]
},
"inputAudioTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscriptionConfig"
},
{
"type": "null"
}
]
},
"model": {
"type": "string"
},
"outputAudioTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscriptionConfig"
},
{
"type": "null"
}
]
},
"proactivity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ProactivityConfig"
},
{
"type": "null"
}
]
},
"realtimeInputConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeInputConfig"
},
{
"type": "null"
}
]
},
"safetySettings": {
"items": {
"$ref": "#/components/schemas/Input_SafetySetting"
},
"type": [
"array",
"null"
]
},
"sessionResumption": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SessionResumptionConfig"
},
{
"type": "null"
}
]
},
"systemInstruction": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveContent"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool3"
},
"type": [
"array",
"null"
]
}
},
"required": [
"model"
],
"type": "object"
}Input_BidiGenerateContentToolResponse
Complete JSON Schema
Referenced structures: Input_FunctionResponse
{
"additionalProperties": true,
"properties": {
"functionResponses": {
"items": {
"$ref": "#/components/schemas/Input_FunctionResponse"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_BidiGenerateContentTranscription
Complete JSON Schema
Referenced structures: Input_WordInfo2
{
"additionalProperties": true,
"properties": {
"finished": {
"type": [
"boolean",
"null"
]
},
"languageCode": {
"type": [
"string",
"null"
]
},
"speakerLabel": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"words": {
"items": {
"$ref": "#/components/schemas/Input_WordInfo2"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_BinaryPart
Complete JSON Schema
{
"format": "binary",
"type": "string"
}Input_Blob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"displayName": {
"type": [
"string",
"null"
]
},
"mimeType": {
"type": "string"
}
},
"required": [
"mimeType",
"data"
],
"type": "object"
}Input_BrowserDownloadCompleted
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"download_id": {
"type": "string"
},
"path": {
"type": [
"string",
"null"
]
},
"size_bytes": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"download_id",
"url"
],
"type": "object"
}Input_BrowserDownloadFailed
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"download_id": {
"type": "string"
},
"error": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"download_id",
"url"
],
"type": "object"
}Input_BrowserDownloadStarted
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"download_id": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"download_id",
"url"
],
"type": "object"
}Input_BrowserStateBlock
Complete JSON Schema
Referenced structures: Input_BrowserStateChange, Input_BrowserStateTab, Input_BrowserStateType, Input_CacheControl
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"state_changes": {
"items": {
"$ref": "#/components/schemas/Input_BrowserStateChange"
},
"type": [
"array",
"null"
]
},
"tabs": {
"items": {
"$ref": "#/components/schemas/Input_BrowserStateTab"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_BrowserStateType"
}
},
"required": [
"type",
"tabs"
],
"type": "object"
}Input_BrowserStateChange
Complete JSON Schema
Referenced structures: Input_BrowserDownloadCompleted, Input_BrowserDownloadFailed, Input_BrowserDownloadStarted, Input_BrowserTabOpened
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_BrowserTabOpened",
"properties": {
"type": {
"const": "tab_opened",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_BrowserDownloadStarted",
"properties": {
"type": {
"const": "download_started",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_BrowserDownloadCompleted",
"properties": {
"type": {
"const": "download_completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_BrowserDownloadFailed",
"properties": {
"type": {
"const": "download_failed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_BrowserStateTab
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"active": {
"type": [
"boolean",
"null"
]
},
"tab_id": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"tab_id",
"title",
"url"
],
"type": "object"
}Input_BrowserStateType
Complete JSON Schema
{
"enum": [
"browser_state"
],
"type": "string"
}Input_BrowserTabOpened
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"tab_id": {
"type": "string"
}
},
"required": [
"tab_id"
],
"type": "object"
}Input_BrowserToolset20260801
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_BrowserToolset20260801Type, Input_BrowserToolsetConfigs, Input_CacheControl
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"configs": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BrowserToolsetConfigs"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_BrowserToolset20260801Type"
}
},
"required": [
"type"
],
"type": "object"
}Input_BrowserToolset20260801Type
Complete JSON Schema
{
"enum": [
"browser_toolset_20260801"
],
"type": "string"
}Input_BrowserToolsetConfigs
Complete JSON Schema
Referenced structures: Input_ToolsetMemberConfig
{
"additionalProperties": true,
"properties": {
"close_tab": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"double_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"file_upload": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"find": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"form_input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"get_page_text": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"hold_key": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"hover": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"javascript_exec": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"key": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_click_drag": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_mouse_down": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_mouse_up": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"list_tabs": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"middle_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"mouse_move": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"navigate": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"new_tab": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"read_console": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"read_network": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"read_page": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"right_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"screenshot": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"scroll": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"scroll_to": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"switch_tab": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"triple_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"wait": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"zoom": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_CacheControl
Complete JSON Schema
Referenced structures: Input_CacheControlType, Input_CacheTtl
{
"additionalProperties": true,
"properties": {
"ttl": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheTtl"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_CacheControlType"
}
},
"required": [
"type"
],
"type": "object"
}Input_CacheControlType
Complete JSON Schema
{
"enum": [
"ephemeral"
],
"type": "string"
}Input_CacheCreationPriceDto
Complete JSON Schema
{
"description": "A cache-write price per million tokens. No TTL is the fallback price.",
"properties": {
"price": {
"type": "string"
},
"ttlSeconds": {
"default": null,
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"price"
],
"type": "object"
}Input_CacheTtl
Complete JSON Schema
{
"enum": [
"5m",
"1h"
],
"type": "string"
}Input_Caller
Complete JSON Schema
Referenced structures: Input_DirectCaller, Input_ProgramCaller
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_DirectCaller",
"properties": {
"type": {
"const": "direct",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ProgramCaller",
"properties": {
"type": {
"const": "program",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_Caller2
Complete JSON Schema
Referenced structures: Input_DirectCaller2, Input_ServerCaller, Input_ServerCaller20260120
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_DirectCaller2",
"properties": {
"type": {
"const": "direct",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ServerCaller",
"properties": {
"type": {
"const": "code_execution_20250825",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ServerCaller20260120",
"properties": {
"type": {
"const": "code_execution_20260120",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_CatalogProviderDto
Complete JSON Schema
{
"properties": {
"displayName": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
}Input_CharCitation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"document_index": {
"format": "int64",
"type": "integer"
},
"document_title": {
"type": "string"
},
"end_char_index": {
"format": "int64",
"type": "integer"
},
"start_char_index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"cited_text",
"document_index",
"document_title",
"end_char_index",
"start_char_index"
],
"type": "object"
}Input_ChatAudioFormat
Complete JSON Schema
{
"enum": [
"wav",
"aac",
"mp3",
"flac",
"opus",
"pcm16"
],
"type": "string"
}Input_ChatAudioParam
Complete JSON Schema
Referenced structures: Input_AudioVoice, Input_ChatAudioFormat
{
"additionalProperties": true,
"properties": {
"format": {
"$ref": "#/components/schemas/Input_ChatAudioFormat"
},
"voice": {
"$ref": "#/components/schemas/Input_AudioVoice"
}
},
"required": [
"voice",
"format"
],
"type": "object"
}Input_ChatMessage
Complete JSON Schema
Referenced structures: Input_AssistantMessage, Input_DeveloperMessage, Input_FunctionMessage, Input_SystemMessage, Input_ToolMessage, Input_UserMessage
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_DeveloperMessage"
},
{
"$ref": "#/components/schemas/Input_SystemMessage"
},
{
"$ref": "#/components/schemas/Input_UserMessage"
},
{
"$ref": "#/components/schemas/Input_AssistantMessage"
},
{
"$ref": "#/components/schemas/Input_ToolMessage"
},
{
"$ref": "#/components/schemas/Input_FunctionMessage"
}
]
}Input_ChatTool
Complete JSON Schema
Referenced structures: Input_CustomToolDefinition, Input_FunctionTool2
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionTool2"
},
{
"$ref": "#/components/schemas/Input_CustomToolDefinition"
}
]
}Input_ChatToolCall
Complete JSON Schema
Referenced structures: Input_ChatToolCallType, Input_FunctionCall3
{
"additionalProperties": true,
"properties": {
"function": {
"$ref": "#/components/schemas/Input_FunctionCall3"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ChatToolCallType"
}
},
"required": [
"id",
"function",
"type"
],
"type": "object"
}Input_ChatToolCallType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Input_ChunkingStrategy
Complete JSON Schema
Referenced structures: Input_AutomaticChunking, Input_VadConfig
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_AutomaticChunking"
},
{
"$ref": "#/components/schemas/Input_VadConfig"
}
]
}Input_CitationsConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"enabled": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_ClearThinkingEdit
Complete JSON Schema
Referenced structures: Input_ClearThinkingType, Input_ThinkingKeep
{
"additionalProperties": true,
"properties": {
"keep": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingKeep"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ClearThinkingType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ClearThinkingType
Complete JSON Schema
{
"enum": [
"clear_thinking_20251015"
],
"type": "string"
}Input_ClearToolInputs
Complete JSON Schema
{
"anyOf": [
{
"type": "boolean"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}Input_ClearToolUsesEdit
Complete JSON Schema
Referenced structures: Input_ClearToolInputs, Input_ClearToolUsesType, Input_ContextTrigger, Input_InputTokensThreshold, Input_ToolUsesKeep
{
"additionalProperties": true,
"properties": {
"clear_at_least": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InputTokensThreshold"
},
{
"type": "null"
}
]
},
"clear_tool_inputs": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ClearToolInputs"
},
{
"type": "null"
}
]
},
"exclude_tools": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"keep": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolUsesKeep"
},
{
"type": "null"
}
]
},
"trigger": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ContextTrigger"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ClearToolUsesType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ClearToolUsesType
Complete JSON Schema
{
"enum": [
"clear_tool_uses_20250919"
],
"type": "string"
}Input_ClickAction
Complete JSON Schema
Referenced structures: Input_ClickButton
{
"additionalProperties": true,
"properties": {
"button": {
"$ref": "#/components/schemas/Input_ClickButton"
},
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"button",
"x",
"y"
],
"type": "object"
}Input_ClickButton
Complete JSON Schema
{
"enum": [
"left",
"right",
"wheel",
"back",
"forward"
],
"type": "string"
}Input_ClickOperation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"ref_id": {
"type": "string"
}
},
"required": [
"ref_id",
"id"
],
"type": "object"
}Input_ClientAdditionalTools
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"role": {
"type": "string"
},
"tools": {
"items": true,
"type": "array"
}
},
"required": [
"role",
"tools"
],
"type": "object"
}Input_ClientAgentMessage
Complete JSON Schema
Referenced structures: Input_AgentMessageInputContent, Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"author": {
"type": "string"
},
"content": {
"items": {
"$ref": "#/components/schemas/Input_AgentMessageInputContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"recipient": {
"type": "string"
}
},
"required": [
"author",
"recipient",
"content"
],
"type": "object"
}Input_ClientCompaction
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
}
},
"required": [
"encrypted_content"
],
"type": "object"
}Input_ClientCompactionTrigger
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ClientConfigurationUpdate
Complete JSON Schema
Referenced structures: Input_ConfigurationReasoning2
{
"additionalProperties": true,
"properties": {
"reasoning": {
"$ref": "#/components/schemas/Input_ConfigurationReasoning2"
}
},
"required": [
"reasoning"
],
"type": "object"
}Input_ClientContextCompaction
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ClientCustomToolCall
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"input": {
"type": "string"
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"namespace": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
]
}
},
"required": [
"call_id",
"name",
"input"
],
"type": "object"
}Input_ClientCustomToolCallOutput
Complete JSON Schema
Referenced structures: Input_FunctionCallOutputBody, Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Input_FunctionCallOutputBody"
}
},
"required": [
"call_id",
"output"
],
"type": "object"
}Input_ClientFunctionCall
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"arguments": {
"type": "string"
},
"call_id": {
"type": "string"
},
"encrypted_function_args": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
},
"namespace": {
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"arguments",
"call_id"
],
"type": "object"
}Input_ClientFunctionCallOutput
Complete JSON Schema
Referenced structures: Input_FunctionCallOutputBody, Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"call_id": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"name": {
"type": [
"string",
"null"
]
},
"namespace": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Input_FunctionCallOutputBody"
}
},
"required": [
"output"
],
"type": "object"
}Input_ClientImageGenerationCall
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"result": {
"type": "string"
},
"revised_prompt": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
}
},
"required": [
"status",
"result"
],
"type": "object"
}Input_ClientLocalShellCall
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough, Input_LocalShellAction2, Input_LocalShellStatus
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Input_LocalShellAction2"
},
"call_id": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": {
"$ref": "#/components/schemas/Input_LocalShellStatus"
}
},
"required": [
"status",
"action",
"call_id"
],
"type": "object"
}Input_ClientMessage
Complete JSON Schema
Referenced structures: Input_ContentItem, Input_InternalChatMessageMetadataPassthrough, Input_MessagePhase2
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_ContentItem"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MessagePhase2"
},
{
"type": "null"
}
]
},
"role": {
"type": "string"
}
},
"required": [
"role",
"content"
],
"type": "object"
}Input_ClientReasoning
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough, Input_ReasoningItemContent, Input_ReasoningItemReasoningSummary
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_ReasoningItemContent"
},
"type": [
"array",
"null"
]
},
"encrypted_content": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"summary": {
"items": {
"$ref": "#/components/schemas/Input_ReasoningItemReasoningSummary"
},
"type": "array"
}
},
"required": [
"summary",
"encrypted_content"
],
"type": "object"
}Input_ClientResponseItem
Complete JSON Schema
Referenced structures: Input_ClientAdditionalTools, Input_ClientAgentMessage, Input_ClientCompaction, Input_ClientCompactionTrigger, Input_ClientConfigurationUpdate, Input_ClientContextCompaction, Input_ClientCustomToolCall, Input_ClientCustomToolCallOutput, Input_ClientFunctionCall, Input_ClientFunctionCallOutput, Input_ClientImageGenerationCall, Input_ClientLocalShellCall, Input_ClientMessage, Input_ClientReasoning, Input_ClientToolSearchCall, Input_ClientToolSearchOutput, Input_ClientWebSearchCall, Input_ResponseItemOther
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ClientAdditionalTools",
"properties": {
"type": {
"const": "additional_tools",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientMessage",
"properties": {
"type": {
"const": "message",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientAgentMessage",
"properties": {
"type": {
"const": "agent_message",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientReasoning",
"properties": {
"type": {
"const": "reasoning",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientLocalShellCall",
"properties": {
"type": {
"const": "local_shell_call",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientFunctionCall",
"properties": {
"type": {
"const": "function_call",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientToolSearchCall",
"properties": {
"type": {
"const": "tool_search_call",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientFunctionCallOutput",
"properties": {
"type": {
"const": "function_call_output",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientCustomToolCall",
"properties": {
"type": {
"const": "custom_tool_call",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientCustomToolCallOutput",
"properties": {
"type": {
"const": "custom_tool_call_output",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientToolSearchOutput",
"properties": {
"type": {
"const": "tool_search_output",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientWebSearchCall",
"properties": {
"type": {
"const": "web_search_call",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientImageGenerationCall",
"properties": {
"type": {
"const": "image_generation_call",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientCompaction",
"properties": {
"type": {
"const": "compaction",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientConfigurationUpdate",
"properties": {
"type": {
"const": "configuration_update",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientCompactionTrigger",
"properties": {
"type": {
"const": "compaction_trigger",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ClientContextCompaction",
"properties": {
"type": {
"const": "context_compaction",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ResponseItemOther",
"properties": {
"type": {
"const": "other",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ClientSecretExpiresAfter
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"anchor": {
"type": [
"string",
"null"
]
},
"seconds": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_ClientSecretSession
Complete JSON Schema
Referenced structures: Input_RealtimeSessionCreateRequest, Input_RealtimeTranscriptionSessionCreateRequest
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequest"
},
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionCreateRequest"
}
]
}Input_ClientToolSearchCall
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"arguments": true,
"call_id": {
"type": [
"string",
"null"
]
},
"execution": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": {
"type": [
"string",
"null"
]
}
},
"required": [
"execution",
"arguments",
"call_id"
],
"type": "object"
}Input_ClientToolSearchOutput
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough
{
"additionalProperties": true,
"properties": {
"call_id": {
"type": [
"string",
"null"
]
},
"execution": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": {
"type": "string"
},
"tools": {
"items": true,
"type": "array"
}
},
"required": [
"status",
"execution",
"tools",
"call_id"
],
"type": "object"
}Input_ClientWebSearchCall
Complete JSON Schema
Referenced structures: Input_InternalChatMessageMetadataPassthrough, Input_WebSearchAction2
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_WebSearchAction2"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"internal_chat_message_metadata_passthrough": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InternalChatMessageMetadataPassthrough"
},
{
"type": "null"
}
]
},
"status": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_CodeExecution
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_CodeExecutionError
Complete JSON Schema
Referenced structures: Input_CodeExecutionErrorCode, Input_CodeExecutionErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Input_CodeExecutionErrorCode"
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Input_CodeExecutionErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded"
],
"type": "string"
}Input_CodeExecutionErrorType
Complete JSON Schema
{
"enum": [
"code_execution_tool_result_error"
],
"type": "string"
}Input_CodeExecutionOutput
Complete JSON Schema
Referenced structures: Input_CodeExecutionOutputType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionOutputType"
}
},
"required": [
"type",
"file_id"
],
"type": "object"
}Input_CodeExecutionOutputType
Complete JSON Schema
{
"enum": [
"code_execution_output"
],
"type": "string"
}Input_CodeExecutionResult
Complete JSON Schema
Referenced structures: Input_CodeExecutionOutput, Input_CodeExecutionResultType
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_CodeExecutionOutput"
},
"type": "array"
},
"return_code": {
"format": "int64",
"type": "integer"
},
"stderr": {
"type": "string"
},
"stdout": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionResultType"
}
},
"required": [
"type",
"content",
"return_code",
"stderr",
"stdout"
],
"type": "object"
}Input_CodeExecutionResult2
Complete JSON Schema
Referenced structures: Input_Outcome
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"outcome": {
"$ref": "#/components/schemas/Input_Outcome"
},
"output": {
"type": [
"string",
"null"
]
}
},
"required": [
"outcome"
],
"type": "object"
}Input_CodeExecutionResultContent
Complete JSON Schema
Referenced structures: Input_CodeExecutionError, Input_CodeExecutionResult, Input_EncryptedCodeExecutionResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_CodeExecutionError"
},
{
"$ref": "#/components/schemas/Input_CodeExecutionResult"
},
{
"$ref": "#/components/schemas/Input_EncryptedCodeExecutionResult"
}
]
}Input_CodeExecutionResultType
Complete JSON Schema
{
"enum": [
"code_execution_result"
],
"type": "string"
}Input_CodeExecutionTool20250522
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CodeExecutionTool20250522Name, Input_CodeExecutionTool20250522Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20250522Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20250522Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_CodeExecutionTool20250522Name
Complete JSON Schema
{
"enum": [
"code_execution"
],
"type": "string"
}Input_CodeExecutionTool20250522Type
Complete JSON Schema
{
"enum": [
"code_execution_20250522"
],
"type": "string"
}Input_CodeExecutionTool20250825
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CodeExecutionTool20250825Name, Input_CodeExecutionTool20250825Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20250825Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20250825Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_CodeExecutionTool20250825Name
Complete JSON Schema
{
"enum": [
"code_execution"
],
"type": "string"
}Input_CodeExecutionTool20250825Type
Complete JSON Schema
{
"enum": [
"code_execution_20250825"
],
"type": "string"
}Input_CodeExecutionTool20260120
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CodeExecutionTool20260120Name, Input_CodeExecutionTool20260120Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20260120Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20260120Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_CodeExecutionTool20260120Name
Complete JSON Schema
{
"enum": [
"code_execution"
],
"type": "string"
}Input_CodeExecutionTool20260120Type
Complete JSON Schema
{
"enum": [
"code_execution_20260120"
],
"type": "string"
}Input_CodeExecutionTool20260521
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CodeExecutionTool20260521Name, Input_CodeExecutionTool20260521Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20260521Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionTool20260521Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_CodeExecutionTool20260521Name
Complete JSON Schema
{
"enum": [
"code_execution"
],
"type": "string"
}Input_CodeExecutionTool20260521Type
Complete JSON Schema
{
"enum": [
"code_execution_20260521"
],
"type": "string"
}Input_CodeExecutionToolResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_CodeExecutionResultContent, Input_CodeExecutionToolResultType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_CodeExecutionResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_CodeExecutionToolResultType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Input_CodeExecutionToolResultType
Complete JSON Schema
{
"enum": [
"code_execution_tool_result"
],
"type": "string"
}Input_CodeImage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}Input_CodeInterpreterAuto
Complete JSON Schema
Referenced structures: Input_AutoContainerType, Input_ContainerNetworkPolicy, Input_MemoryLimit
{
"additionalProperties": true,
"properties": {
"file_ids": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"memory_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MemoryLimit"
},
{
"type": "null"
}
]
},
"network_policy": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ContainerNetworkPolicy"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_AutoContainerType"
}
},
"required": [
"type"
],
"type": "object"
}Input_CodeInterpreterCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_CodeInterpreterCallType, Input_CodeInterpreterOutput, Input_CodeInterpreterStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"code": {
"type": [
"string",
"null"
]
},
"container_id": {
"type": "string"
},
"id": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/Input_CodeInterpreterOutput"
},
"type": [
"array",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Input_CodeInterpreterStatus"
},
"type": {
"$ref": "#/components/schemas/Input_CodeInterpreterCallType"
}
},
"required": [
"type",
"id",
"container_id",
"status",
"code",
"outputs"
],
"type": "object"
}Input_CodeInterpreterCallType
Complete JSON Schema
{
"enum": [
"code_interpreter_call"
],
"type": "string"
}Input_CodeInterpreterContainer
Complete JSON Schema
Referenced structures: Input_CodeInterpreterAuto
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_CodeInterpreterAuto"
}
]
}Input_CodeInterpreterOutput
Complete JSON Schema
Referenced structures: Input_CodeImage, Input_CodeLogs
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_CodeLogs",
"properties": {
"type": {
"const": "logs",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_CodeImage",
"properties": {
"type": {
"const": "image",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_CodeInterpreterStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete",
"interpreting",
"failed"
],
"type": "string"
}Input_CodeInterpreterTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller, Input_CodeInterpreterContainer
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"container": {
"$ref": "#/components/schemas/Input_CodeInterpreterContainer"
}
},
"required": [
"container"
],
"type": "object"
}Input_CodeLogs
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"logs": {
"type": "string"
}
},
"required": [
"logs"
],
"type": "object"
}Input_CompactEdit
Complete JSON Schema
Referenced structures: Input_CompactType, Input_InputTokensThreshold
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": [
"string",
"null"
]
},
"pause_after_compaction": {
"type": [
"boolean",
"null"
]
},
"trigger": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InputTokensThreshold"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_CompactType"
}
},
"required": [
"type"
],
"type": "object"
}Input_CompactRequestBody
Complete JSON Schema
Referenced structures: Input_Input, Input_PromptCacheOptions, Input_PromptCacheRetention, Input_ServiceTier5
{
"additionalProperties": true,
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Input"
},
{
"type": "null"
}
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"previous_response_id": {
"type": [
"string",
"null"
]
},
"prompt_cache_key": {
"type": [
"string",
"null"
]
},
"prompt_cache_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheOptions"
},
{
"type": "null"
}
]
},
"prompt_cache_retention": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheRetention"
},
{
"type": "null"
}
]
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ServiceTier5"
},
{
"type": "null"
}
]
}
},
"required": [
"model"
],
"type": "object"
}Input_CompactType
Complete JSON Schema
{
"enum": [
"compact_20260112"
],
"type": "string"
}Input_Compaction
Complete JSON Schema
Referenced structures: Input_Agent, Input_CompactionType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"encrypted_content": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CompactionType"
}
},
"required": [
"type",
"encrypted_content"
],
"type": "object"
}Input_CompactionBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_CompactionType2
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"type": [
"string",
"null"
]
},
"encrypted_content": {
"type": [
"string",
"null"
]
},
"signature": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CompactionType2"
}
},
"required": [
"type"
],
"type": "object"
}Input_CompactionConfig
Complete JSON Schema
Referenced structures: Input_CompactionConfigType
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CompactionConfigType"
}
},
"required": [
"type"
],
"type": "object"
}Input_CompactionConfigType
Complete JSON Schema
{
"enum": [
"summarize"
],
"type": "string"
}Input_CompactionTrigger
Complete JSON Schema
Referenced structures: Input_Agent, Input_CompactionTriggerType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_CompactionTriggerType"
}
},
"required": [
"type"
],
"type": "object"
}Input_CompactionTriggerType
Complete JSON Schema
{
"enum": [
"compaction_trigger"
],
"type": "string"
}Input_CompactionType
Complete JSON Schema
{
"enum": [
"compaction"
],
"type": "string"
}Input_CompactionType2
Complete JSON Schema
{
"enum": [
"compaction"
],
"type": "string"
}Input_ComparisonFilter
Complete JSON Schema
Referenced structures: Input_ComparisonFilterType, Input_FilterValue
{
"additionalProperties": true,
"properties": {
"key": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ComparisonFilterType"
},
"value": {
"$ref": "#/components/schemas/Input_FilterValue"
}
},
"required": [
"key",
"value",
"type"
],
"type": "object"
}Input_ComparisonFilterType
Complete JSON Schema
{
"enum": [
"eq",
"ne",
"gt",
"gte",
"lt",
"lte",
"in",
"nin"
],
"type": "string"
}Input_CompoundFilter
Complete JSON Schema
Referenced structures: Input_CompoundFilterType, Input_FileSearchFilter
{
"additionalProperties": true,
"properties": {
"filters": {
"items": {
"$ref": "#/components/schemas/Input_FileSearchFilter"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_CompoundFilterType"
}
},
"required": [
"filters",
"type"
],
"type": "object"
}Input_CompoundFilterType
Complete JSON Schema
{
"enum": [
"and",
"or"
],
"type": "string"
}Input_ComputerAction
Complete JSON Schema
Referenced structures: Input_ClickAction, Input_DoubleClickAction, Input_DragAction, Input_KeypressAction, Input_MoveAction, Input_ScreenshotAction, Input_ScrollAction, Input_TypeAction, Input_WaitAction
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ClickAction",
"properties": {
"type": {
"const": "click",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_DoubleClickAction",
"properties": {
"type": {
"const": "double_click",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_DragAction",
"properties": {
"type": {
"const": "drag",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_KeypressAction",
"properties": {
"type": {
"const": "keypress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_MoveAction",
"properties": {
"type": {
"const": "move",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ScreenshotAction",
"properties": {
"type": {
"const": "screenshot",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ScrollAction",
"properties": {
"type": {
"const": "scroll",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_TypeAction",
"properties": {
"type": {
"const": "type",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WaitAction",
"properties": {
"type": {
"const": "wait",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ComputerCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_ComputerAction, Input_ComputerCallType, Input_ItemStatus, Input_PendingSafetyCheck
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ComputerAction"
},
{
"type": "null"
}
]
},
"actions": {
"items": {
"$ref": "#/components/schemas/Input_ComputerAction"
},
"type": [
"array",
"null"
]
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"pending_safety_checks": {
"items": {
"$ref": "#/components/schemas/Input_PendingSafetyCheck"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/Input_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Input_ComputerCallType"
}
},
"required": [
"type",
"id",
"call_id",
"pending_safety_checks",
"status"
],
"type": "object"
}Input_ComputerCallOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_ComputerCallOutputType, Input_ComputerScreenshot, Input_ItemStatus, Input_PendingSafetyCheck
{
"additionalProperties": true,
"properties": {
"acknowledged_safety_checks": {
"items": {
"$ref": "#/components/schemas/Input_PendingSafetyCheck"
},
"type": [
"array",
"null"
]
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Input_ComputerScreenshot"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ComputerCallOutputType"
}
},
"required": [
"type",
"call_id",
"output"
],
"type": "object"
}Input_ComputerCallOutputType
Complete JSON Schema
{
"enum": [
"computer_call_output"
],
"type": "string"
}Input_ComputerCallType
Complete JSON Schema
{
"enum": [
"computer_call"
],
"type": "string"
}Input_ComputerEnvironment
Complete JSON Schema
{
"enum": [
"windows",
"mac",
"linux",
"ubuntu",
"browser"
],
"type": "string"
}Input_ComputerEnvironment2
Complete JSON Schema
{
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"ENVIRONMENT_BROWSER",
"ENVIRONMENT_MOBILE",
"ENVIRONMENT_DESKTOP"
],
"type": "string"
}Input_ComputerScreenshot
Complete JSON Schema
Referenced structures: Input_ComputerScreenshotType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ComputerScreenshotType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ComputerScreenshotType
Complete JSON Schema
{
"enum": [
"computer_screenshot"
],
"type": "string"
}Input_ComputerTool
Complete JSON Schema
Referenced structures: Input_ComputerEnvironment
{
"additionalProperties": true,
"properties": {
"display_height": {
"format": "int64",
"type": "integer"
},
"display_width": {
"format": "int64",
"type": "integer"
},
"environment": {
"$ref": "#/components/schemas/Input_ComputerEnvironment"
}
},
"required": [
"display_height",
"display_width",
"environment"
],
"type": "object"
}Input_ComputerTool20241022
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_ComputerTool20241022Name, Input_ComputerTool20241022Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"display_height_px": {
"format": "int64",
"type": "integer"
},
"display_number": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"display_width_px": {
"format": "int64",
"type": "integer"
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_ComputerTool20241022Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ComputerTool20241022Type"
}
},
"required": [
"name",
"type",
"display_height_px",
"display_width_px"
],
"type": "object"
}Input_ComputerTool20241022Name
Complete JSON Schema
{
"enum": [
"computer"
],
"type": "string"
}Input_ComputerTool20241022Type
Complete JSON Schema
{
"enum": [
"computer_20241022"
],
"type": "string"
}Input_ComputerTool20250124
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_ComputerTool20250124Name, Input_ComputerTool20250124Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"display_height_px": {
"format": "int64",
"type": "integer"
},
"display_number": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"display_width_px": {
"format": "int64",
"type": "integer"
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_ComputerTool20250124Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ComputerTool20250124Type"
}
},
"required": [
"name",
"type",
"display_height_px",
"display_width_px"
],
"type": "object"
}Input_ComputerTool20250124Name
Complete JSON Schema
{
"enum": [
"computer"
],
"type": "string"
}Input_ComputerTool20250124Type
Complete JSON Schema
{
"enum": [
"computer_20250124"
],
"type": "string"
}Input_ComputerTool20251124
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_ComputerTool20251124Name, Input_ComputerTool20251124Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"display_height_px": {
"format": "int64",
"type": "integer"
},
"display_number": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"display_width_px": {
"format": "int64",
"type": "integer"
},
"enable_zoom": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_ComputerTool20251124Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ComputerTool20251124Type"
}
},
"required": [
"name",
"type",
"display_height_px",
"display_width_px"
],
"type": "object"
}Input_ComputerTool20251124Name
Complete JSON Schema
{
"enum": [
"computer"
],
"type": "string"
}Input_ComputerTool20251124Type
Complete JSON Schema
{
"enum": [
"computer_20251124"
],
"type": "string"
}Input_ComputerToolset20260801
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ComputerToolset20260801Type, Input_ComputerToolsetConfigs
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"configs": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ComputerToolsetConfigs"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ComputerToolset20260801Type"
}
},
"required": [
"type"
],
"type": "object"
}Input_ComputerToolset20260801Type
Complete JSON Schema
{
"enum": [
"computer_toolset_20260801"
],
"type": "string"
}Input_ComputerToolsetConfigs
Complete JSON Schema
Referenced structures: Input_ToolsetMemberConfig
{
"additionalProperties": true,
"properties": {
"cursor_position": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"double_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"hold_key": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"key": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_click_drag": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_mouse_down": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"left_mouse_up": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"middle_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"mouse_move": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"right_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"screenshot": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"scroll": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"triple_click": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"wait": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
},
"zoom": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolsetMemberConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ComputerUse
Complete JSON Schema
Referenced structures: Input_ComputerEnvironment2, Input_ComputerUseSafetyPolicy
{
"additionalProperties": true,
"properties": {
"disabledSafetyPolicies": {
"items": {
"$ref": "#/components/schemas/Input_ComputerUseSafetyPolicy"
},
"type": [
"array",
"null"
]
},
"enablePromptInjectionDetection": {
"type": [
"boolean",
"null"
]
},
"environment": {
"$ref": "#/components/schemas/Input_ComputerEnvironment2"
},
"excludedPredefinedFunctions": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"required": [
"environment"
],
"type": "object"
}Input_ComputerUseSafetyPolicy
Complete JSON Schema
{
"enum": [
"SAFETY_POLICY_UNSPECIFIED",
"FINANCIAL_TRANSACTIONS",
"SENSITIVE_DATA_MODIFICATION",
"COMMUNICATION_TOOL",
"ACCOUNT_CREATION",
"DATA_MODIFICATION",
"USER_CONSENT_MANAGEMENT",
"LEGAL_TERMS_AND_AGREEMENTS"
],
"type": "string"
}Input_ConfigurationDataDto
Complete JSON Schema
Referenced structures: Input_ConnectionProfileDto, Input_ExportCredentialDto, Input_ModelDto, Input_OperationEndpointDto, Input_OperationRuleDto, Input_PriceRateDto, Input_PriceRuleDto, Input_PriceTierDto, Input_ProviderDto, Input_ProviderModelDto, Input_ProviderRuleSetDto, Input_QuotaDto, Input_RewriteRuleDto, Input_RouteDto, Input_RouteMemberDto, Input_RuleSetDto, Input_SettingsDto
{
"description": "Every exported table, in the order a fresh instance may replay them: a row\nnever appears before the row it points at. Each field defaults to empty, so\na document written by a build that knew fewer tables still imports.",
"properties": {
"connectionProfiles": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_ConnectionProfileDto"
},
"type": "array"
},
"credentials": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_ExportCredentialDto"
},
"type": "array"
},
"models": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_ModelDto"
},
"type": "array"
},
"operationEndpoints": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_OperationEndpointDto"
},
"type": "array"
},
"operationRules": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_OperationRuleDto"
},
"type": "array"
},
"priceRates": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_PriceRateDto"
},
"type": "array"
},
"priceRules": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_PriceRuleDto"
},
"type": "array"
},
"priceTiers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_PriceTierDto"
},
"type": "array"
},
"providerModels": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_ProviderModelDto"
},
"type": "array"
},
"providerRewriteRuleSets": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_ProviderRuleSetDto"
},
"type": "array"
},
"providers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_ProviderDto"
},
"type": "array"
},
"quotas": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_QuotaDto"
},
"type": "array"
},
"rewriteRuleSets": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_RuleSetDto"
},
"type": "array"
},
"rewriteRules": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_RewriteRuleDto"
},
"type": "array"
},
"routeMembers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_RouteMemberDto"
},
"type": "array"
},
"routes": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_RouteDto"
},
"type": "array"
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SettingsDto"
},
{
"type": "null"
}
],
"default": null,
"description": "The single settings row. `config_revision` travels but is never\nimported: the destination's revision is its own counter."
}
},
"type": "object"
}Input_ConfigurationExportDto
Complete JSON Schema
Referenced structures: Input_ConfigurationDataDto
{
"description": "One instance's configuration as a document.",
"properties": {
"data": {
"$ref": "#/components/schemas/Input_ConfigurationDataDto"
},
"exportedAtMs": {
"format": "int64",
"type": "integer"
},
"formatVersion": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"secrets": {
"description": "The sealing codecs the exported blobs actually use, sorted and without\nduplicates; empty when the secrets were omitted. An importer reads it\nbefore it starts, to decide whether it needs a source master key at all.",
"items": {
"type": "string"
},
"type": "array"
},
"secretsOmitted": {
"description": "True when the export was taken without secrets: every credential's\n`secret` is null.",
"type": "boolean"
}
},
"required": [
"formatVersion",
"exportedAtMs",
"secretsOmitted",
"secrets",
"data"
],
"type": "object"
}Input_ConfigurationReasoning
Complete JSON Schema
Referenced structures: Input_ReasoningEffort
{
"additionalProperties": true,
"properties": {
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningEffort"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ConfigurationReasoning2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"effort": {
"type": "string"
}
},
"required": [
"effort"
],
"type": "object"
}Input_ConfigurationUpdate
Complete JSON Schema
Referenced structures: Input_Agent, Input_ConfigurationReasoning, Input_ConfigurationUpdateType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ConfigurationReasoning"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ConfigurationUpdateType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ConfigurationUpdateType
Complete JSON Schema
{
"enum": [
"configuration_update"
],
"type": "string"
}Input_ConnectionProfileDto
Complete JSON Schema
{
"additionalProperties": false,
"description": "A reusable HTTP transport configuration, independent of outbound proxy selection.",
"properties": {
"backend": {
"description": "`reqwest`, `wreq` or `reqwest_native`.",
"type": "string"
},
"brotli": {
"type": "boolean"
},
"connectTimeoutMs": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"deflate": {
"type": "boolean"
},
"emulation": {
"description": "A `gproxy-client` emulation object, or null. wreq applies the full identity; other clients apply supported custom fields."
},
"gzip": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"poolIdleTimeoutMs": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"poolMaxIdlePerHost": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"redirectMaxHops": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"retry": {
"description": "`never` or `default`.",
"type": "string"
},
"zstd": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"backend",
"gzip",
"brotli",
"deflate",
"zstd",
"redirectMaxHops",
"retry",
"connectTimeoutMs",
"poolIdleTimeoutMs",
"poolMaxIdlePerHost",
"createdAtMs"
],
"type": "object"
}Input_ConnectionProfilePatch
Complete JSON Schema
{
"additionalProperties": false,
"properties": {
"backend": {
"default": null,
"type": [
"string",
"null"
]
},
"brotli": {
"default": null,
"type": [
"boolean",
"null"
]
},
"connectTimeoutMs": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"deflate": {
"default": null,
"type": [
"boolean",
"null"
]
},
"emulation": {
"default": null
},
"gzip": {
"default": null,
"type": [
"boolean",
"null"
]
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"poolIdleTimeoutMs": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"poolMaxIdlePerHost": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"redirectMaxHops": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"retry": {
"default": null,
"type": [
"string",
"null"
]
},
"zstd": {
"default": null,
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_ConnectionProfileWrite
Complete JSON Schema
{
"additionalProperties": false,
"properties": {
"backend": {
"default": null,
"type": [
"string",
"null"
]
},
"brotli": {
"default": null,
"type": [
"boolean",
"null"
]
},
"connectTimeoutMs": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"deflate": {
"default": null,
"type": [
"boolean",
"null"
]
},
"emulation": {
"default": null
},
"gzip": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"poolIdleTimeoutMs": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"poolMaxIdlePerHost": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"redirectMaxHops": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"retry": {
"default": null,
"type": [
"string",
"null"
]
},
"zstd": {
"default": null,
"type": [
"boolean",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_ConnectivityTest
Complete JSON Schema
{
"description": "What a connectivity test should exercise. Each variant resolves the same\nclient chain a real call would: the credential's profile, then the\nprovider's, then the channel's default, then the instance default.",
"oneOf": [
{
"description": "The instance default profile, with no provider in the picture.",
"properties": {
"scope": {
"const": "global",
"type": "string"
}
},
"required": [
"scope"
],
"type": "object"
},
{
"properties": {
"provider_id": {
"type": "string"
},
"scope": {
"const": "provider",
"type": "string"
}
},
"required": [
"scope",
"provider_id"
],
"type": "object"
},
{
"description": "The chain that credential's own calls take.",
"properties": {
"credential_id": {
"type": "string"
},
"scope": {
"const": "credential",
"type": "string"
}
},
"required": [
"scope",
"credential_id"
],
"type": "object"
},
{
"description": "A proxy that is not configured anywhere yet: the reason this exists is\nto test one before saving it.",
"properties": {
"scope": {
"const": "proxy",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"scope",
"url"
],
"type": "object"
}
],
"properties": {
"proxy": {
"default": null,
"description": "Omitted tests saved settings; null previews inheritance at this scope."
}
},
"type": "object"
}Input_ConnectorId
Complete JSON Schema
{
"enum": [
"connector_dropbox",
"connector_gmail",
"connector_googlecalendar",
"connector_googledrive",
"connector_microsoftteams",
"connector_outlookcalendar",
"connector_outlookemail",
"connector_sharepoint"
],
"type": "string"
}Input_ConsentDecision
Complete JSON Schema
{
"description": "What the person at the consent screen chose.\n\nNamed `ConsentDecision` rather than `Decision` because\n[`snapshot::Decision`](crate::snapshot::Decision) is the permission\nevaluator's verdict, and the two appear in the same files.",
"enum": [
"approve",
"deny"
],
"type": "string"
}Input_ContainerFileCitation
Complete JSON Schema
Referenced structures: Input_ContainerFileCitationType
{
"additionalProperties": true,
"properties": {
"container_id": {
"type": "string"
},
"end_index": {
"format": "int64",
"type": "integer"
},
"file_id": {
"type": "string"
},
"filename": {
"type": "string"
},
"start_index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Input_ContainerFileCitationType"
}
},
"required": [
"container_id",
"end_index",
"file_id",
"filename",
"start_index",
"type"
],
"type": "object"
}Input_ContainerFileCitationType
Complete JSON Schema
{
"enum": [
"container_file_citation"
],
"type": "string"
}Input_ContainerNetworkPolicy
Complete JSON Schema
Referenced structures: Input_NetworkAllowlist, Input_NetworkDisabled
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_NetworkDisabled"
},
{
"$ref": "#/components/schemas/Input_NetworkAllowlist"
}
]
}Input_ContainerParam
Complete JSON Schema
Referenced structures: Input_ContainerParams
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_ContainerParams"
}
]
}Input_ContainerParams
Complete JSON Schema
Referenced structures: Input_SkillParam
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"skills": {
"items": {
"$ref": "#/components/schemas/Input_SkillParam"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_ContainerUploadBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ContainerUploadType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"file_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ContainerUploadType"
}
},
"required": [
"type",
"file_id"
],
"type": "object"
}Input_ContainerUploadType
Complete JSON Schema
{
"enum": [
"container_upload"
],
"type": "string"
}Input_Content
Complete JSON Schema
Referenced structures: Input_Part
{
"additionalProperties": true,
"properties": {
"parts": {
"items": {
"$ref": "#/components/schemas/Input_Part"
},
"type": [
"array",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ContentBlock
Complete JSON Schema
Referenced structures: Input_AdvisorToolResultBlock, Input_BashCodeExecutionToolResultBlock, Input_CodeExecutionToolResultBlock, Input_CompactionBlock, Input_ContainerUploadBlock, Input_DocumentBlock, Input_FallbackBlock, Input_ImageBlock, Input_McpToolListingBlock, Input_McpToolResultBlock, Input_McpToolUseBlock, Input_MidConversationSystemBlock, Input_RedactedThinkingBlock, Input_SearchResultBlock, Input_ServerToolUseBlock, Input_TextBlock, Input_TextEditorCodeExecutionToolResultBlock, Input_ThinkingBlock, Input_ToolAdditionBlock, Input_ToolRemovalBlock, Input_ToolResultBlock, Input_ToolSearchToolResultBlock, Input_ToolUseBlock, Input_WebFetchToolResultBlock, Input_WebSearchToolResultBlock
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextBlock"
},
{
"$ref": "#/components/schemas/Input_ImageBlock"
},
{
"$ref": "#/components/schemas/Input_DocumentBlock"
},
{
"$ref": "#/components/schemas/Input_ThinkingBlock"
},
{
"$ref": "#/components/schemas/Input_RedactedThinkingBlock"
},
{
"$ref": "#/components/schemas/Input_ToolUseBlock"
},
{
"$ref": "#/components/schemas/Input_ToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_ServerToolUseBlock"
},
{
"$ref": "#/components/schemas/Input_SearchResultBlock"
},
{
"$ref": "#/components/schemas/Input_WebSearchToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_WebFetchToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_AdvisorToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_CodeExecutionToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_BashCodeExecutionToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_TextEditorCodeExecutionToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_ToolSearchToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_McpToolListingBlock"
},
{
"$ref": "#/components/schemas/Input_McpToolUseBlock"
},
{
"$ref": "#/components/schemas/Input_McpToolResultBlock"
},
{
"$ref": "#/components/schemas/Input_ContainerUploadBlock"
},
{
"$ref": "#/components/schemas/Input_CompactionBlock"
},
{
"$ref": "#/components/schemas/Input_MidConversationSystemBlock"
},
{
"$ref": "#/components/schemas/Input_ToolAdditionBlock"
},
{
"$ref": "#/components/schemas/Input_ToolRemovalBlock"
},
{
"$ref": "#/components/schemas/Input_FallbackBlock"
}
]
}Input_ContentBlockCitation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"document_index": {
"format": "int64",
"type": "integer"
},
"document_title": {
"type": "string"
},
"end_block_index": {
"format": "int64",
"type": "integer"
},
"start_block_index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"cited_text",
"document_index",
"document_title",
"end_block_index",
"start_block_index"
],
"type": "object"
}Input_ContentItem
Complete JSON Schema
Referenced structures: Input_ContentItemInputAudio, Input_ContentItemInputImage, Input_ContentItemInputText, Input_ContentItemOutputText
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ContentItemInputText",
"properties": {
"type": {
"const": "input_text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ContentItemInputImage",
"properties": {
"type": {
"const": "input_image",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ContentItemInputAudio",
"properties": {
"type": {
"const": "input_audio",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ContentItemOutputText",
"properties": {
"type": {
"const": "output_text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ContentItemInputAudio
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"audio_url": {
"type": "string"
}
},
"required": [
"audio_url"
],
"type": "object"
}Input_ContentItemInputImage
Complete JSON Schema
Referenced structures: Input_ImageDetail3
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageDetail3"
},
{
"type": "null"
}
]
},
"image_url": {
"type": "string"
}
},
"required": [
"image_url"
],
"type": "object"
}Input_ContentItemInputText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_ContentItemOutputText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_ContentSource
Complete JSON Schema
Referenced structures: Input_DocumentContent
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_DocumentContent"
}
},
"required": [
"content"
],
"type": "object"
}Input_ContextEdit
Complete JSON Schema
Referenced structures: Input_ClearThinkingEdit, Input_ClearToolUsesEdit, Input_CompactEdit
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ClearToolUsesEdit"
},
{
"$ref": "#/components/schemas/Input_ClearThinkingEdit"
},
{
"$ref": "#/components/schemas/Input_CompactEdit"
}
]
}Input_ContextManagement
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"compact_threshold": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Input_ContextManagementConfig
Complete JSON Schema
Referenced structures: Input_ContextEdit
{
"additionalProperties": true,
"properties": {
"edits": {
"items": {
"$ref": "#/components/schemas/Input_ContextEdit"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_ContextTrigger
Complete JSON Schema
Referenced structures: Input_InputTokensThreshold, Input_ToolUsesKeep
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_InputTokensThreshold"
},
{
"$ref": "#/components/schemas/Input_ToolUsesKeep"
}
]
}Input_ContextWindowCompressionConfig
Complete JSON Schema
Referenced structures: Input_LiveInt64, Input_SlidingWindow
{
"additionalProperties": true,
"properties": {
"slidingWindow": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SlidingWindow"
},
{
"type": "null"
}
]
},
"triggerTokens": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveInt64"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ConversationItem
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemAssistantMessage, Input_RealtimeConversationItemFunctionCall, Input_RealtimeConversationItemFunctionCallOutput, Input_RealtimeConversationItemSystemMessage, Input_RealtimeConversationItemUserMessage, Input_RealtimeMcpApprovalRequest, Input_RealtimeMcpApprovalResponse, Input_RealtimeMcpListTools, Input_RealtimeMcpToolCall
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemSystemMessage"
},
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessage"
},
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemAssistantMessage"
},
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCall"
},
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCallOutput"
},
{
"$ref": "#/components/schemas/Input_RealtimeMcpApprovalResponse"
},
{
"$ref": "#/components/schemas/Input_RealtimeMcpListTools"
},
{
"$ref": "#/components/schemas/Input_RealtimeMcpToolCall"
},
{
"$ref": "#/components/schemas/Input_RealtimeMcpApprovalRequest"
}
],
"description": "Source: `openai/types/realtime/conversation_item.py`, `ConversationItem`."
}Input_ConversationItemCreateEvent
Complete JSON Schema
Referenced structures: Input_ConversationItem, Input_ConversationItemCreateEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_create_event.py`, `ConversationItemCreateEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"item": {
"$ref": "#/components/schemas/Input_ConversationItem"
},
"previous_item_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ConversationItemCreateEventType"
}
},
"required": [
"item",
"type"
],
"type": "object"
}Input_ConversationItemCreateEventType
Complete JSON Schema
{
"enum": [
"conversation.item.create"
],
"type": "string"
}Input_ConversationItemDeleteEvent
Complete JSON Schema
Referenced structures: Input_ConversationItemDeleteEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_delete_event.py`, `ConversationItemDeleteEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ConversationItemDeleteEventType"
}
},
"required": [
"item_id",
"type"
],
"type": "object"
}Input_ConversationItemDeleteEventType
Complete JSON Schema
{
"enum": [
"conversation.item.delete"
],
"type": "string"
}Input_ConversationItemRetrieveEvent
Complete JSON Schema
Referenced structures: Input_ConversationItemRetrieveEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_retrieve_event.py`, `ConversationItemRetrieveEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ConversationItemRetrieveEventType"
}
},
"required": [
"item_id",
"type"
],
"type": "object"
}Input_ConversationItemRetrieveEventType
Complete JSON Schema
{
"enum": [
"conversation.item.retrieve"
],
"type": "string"
}Input_ConversationItemTruncateEvent
Complete JSON Schema
Referenced structures: Input_ConversationItemTruncateEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_truncate_event.py`, `ConversationItemTruncateEvent`.",
"properties": {
"audio_end_ms": {
"format": "int64",
"type": "integer"
},
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": [
"string",
"null"
]
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ConversationItemTruncateEventType"
}
},
"required": [
"audio_end_ms",
"content_index",
"item_id",
"type"
],
"type": "object"
}Input_ConversationItemTruncateEventType
Complete JSON Schema
{
"enum": [
"conversation.item.truncate"
],
"type": "string"
}Input_ConversationParam
Complete JSON Schema
Referenced structures: Input_ResponseConversationParam
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_ResponseConversationParam"
}
]
}Input_Coordinate
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"x",
"y"
],
"type": "object"
}Input_CountTokensRequestBody
Complete JSON Schema
Referenced structures: Input_ConversationParam, Input_Input, Input_ReasoningConfig, Input_TextConfig, Input_Tool, Input_ToolChoice, Input_Truncation
{
"additionalProperties": true,
"properties": {
"conversation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ConversationParam"
},
{
"type": "null"
}
]
},
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Input"
},
{
"type": "null"
}
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"personality": {
"type": [
"string",
"null"
]
},
"previous_response_id": {
"type": [
"string",
"null"
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningConfig"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextConfig"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoice"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool"
},
"type": [
"array",
"null"
]
},
"truncation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Truncation"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_CountTokensRequestBody2
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ContextManagementConfig, Input_JsonOutputFormat, Input_McpServerUrlDefinition, Input_Message, Input_OutputConfig, Input_Speed, Input_SystemPrompt, Input_ThinkingConfig, Input_ToolChoice2, Input_ToolUnion
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"context_management": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ContextManagementConfig"
},
{
"type": "null"
}
]
},
"mcp_servers": {
"items": {
"$ref": "#/components/schemas/Input_McpServerUrlDefinition"
},
"type": [
"array",
"null"
]
},
"messages": {
"items": {
"$ref": "#/components/schemas/Input_Message"
},
"type": "array"
},
"model": {
"type": "string"
},
"output_config": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_OutputConfig"
},
{
"type": "null"
}
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_JsonOutputFormat"
},
{
"type": "null"
}
]
},
"speed": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Speed"
},
{
"type": "null"
}
]
},
"system": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SystemPrompt"
},
{
"type": "null"
}
]
},
"thinking": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingConfig"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoice2"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_ToolUnion"
},
"type": [
"array",
"null"
]
}
},
"required": [
"messages",
"model"
],
"type": "object"
}Input_CountTokensRequestBody3
Complete JSON Schema
Referenced structures: Input_Content, Input_EmbeddedGenerateContentRequest
{
"additionalProperties": true,
"description": "Body for `POST .../{model=models/*}:countTokens`; `model` is the path resource.",
"properties": {
"contents": {
"items": {
"$ref": "#/components/schemas/Input_Content"
},
"type": [
"array",
"null"
]
},
"generateContentRequest": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_EmbeddedGenerateContentRequest"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_CreateConversationRequestBody
Complete JSON Schema
Referenced structures: Input_InputItem
{
"additionalProperties": true,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Input_InputItem"
},
"type": [
"array",
"null"
]
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}Input_CreateDecisionRequestBody
Complete JSON Schema
Referenced structures: Input_DecisionInput, Input_DecisionQuestion
{
"additionalProperties": true,
"properties": {
"input": {
"$ref": "#/components/schemas/Input_DecisionInput"
},
"model": {
"type": "string"
},
"questions": {
"items": {
"$ref": "#/components/schemas/Input_DecisionQuestion"
},
"type": "array"
},
"safety_identifier": {
"type": [
"string",
"null"
]
}
},
"required": [
"model",
"input",
"questions"
],
"type": "object"
}Input_CreateEmbeddingRequestBody
Complete JSON Schema
Referenced structures: Input_EmbeddingEncodingFormat, Input_EmbeddingInput
{
"additionalProperties": true,
"properties": {
"dimensions": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"encoding_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_EmbeddingEncodingFormat"
},
{
"type": "null"
}
]
},
"input": {
"$ref": "#/components/schemas/Input_EmbeddingInput"
},
"model": {
"type": "string"
},
"user": {
"type": [
"string",
"null"
]
}
},
"required": [
"input",
"model"
],
"type": "object"
}Input_CreateImageRequestBody
Complete JSON Schema
Referenced structures: Input_ImageBackground2, Input_ImageModeration, Input_ImageOutputFormat2, Input_ImageQuality2, Input_ImageResponseFormat2, Input_ImageStyle
{
"additionalProperties": true,
"properties": {
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageBackground2"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageModeration"
},
{
"type": "null"
}
]
},
"n": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output_compression": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageOutputFormat2"
},
{
"type": "null"
}
]
},
"partial_images": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"prompt": {
"type": "string"
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageQuality2"
},
{
"type": "null"
}
]
},
"response_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageResponseFormat2"
},
{
"type": "null"
}
]
},
"size": {
"type": [
"string",
"null"
]
},
"stream": {
"type": [
"boolean",
"null"
]
},
"style": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageStyle"
},
{
"type": "null"
}
]
},
"user": {
"type": [
"string",
"null"
]
}
},
"required": [
"prompt"
],
"type": "object"
}Input_CreateLiveCallMultipartForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_LiveSessionCreateRequest
{
"properties": {
"sdp": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"session": {
"$ref": "#/components/schemas/Input_LiveSessionCreateRequest"
}
},
"required": [
"sdp",
"session"
],
"type": "object"
}Input_CreateLiveSessionRequestBody
Complete JSON Schema
Referenced structures: Input_LiveCreateTransport, Input_LiveSessionConfig
{
"additionalProperties": true,
"properties": {
"session": {
"$ref": "#/components/schemas/Input_LiveSessionConfig"
},
"transport": {
"$ref": "#/components/schemas/Input_LiveCreateTransport"
}
},
"required": [
"session",
"transport"
],
"type": "object"
}Input_CreateModerationRequestBody
Complete JSON Schema
Referenced structures: Input_ModerationInput
{
"additionalProperties": true,
"properties": {
"input": {
"$ref": "#/components/schemas/Input_ModerationInput"
},
"model": {
"type": [
"string",
"null"
]
}
},
"required": [
"input"
],
"type": "object"
}Input_CreatePromptVoiceRequestBody
Complete JSON Schema
Referenced structures: Input_PromptVoiceType
{
"additionalProperties": true,
"properties": {
"model": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"prompt": {
"type": "string"
},
"script_hint": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_PromptVoiceType"
}
},
"required": [
"type",
"name",
"prompt"
],
"type": "object"
}Input_CreateRealtimeCallMultipartForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_RealtimeSessionCreateRequest
{
"properties": {
"sdp": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequest"
},
{
"type": "null"
}
]
}
},
"required": [
"sdp"
],
"type": "object"
}Input_CreateRealtimeClientSecretRequestBody
Complete JSON Schema
Referenced structures: Input_ClientSecretExpiresAfter, Input_ClientSecretSession
{
"additionalProperties": true,
"properties": {
"expires_after": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ClientSecretExpiresAfter"
},
{
"type": "null"
}
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ClientSecretSession"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_CreateSampleVoiceMultipartForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_VoiceSource
{
"properties": {
"audio_sample": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"consent": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_VoiceSource"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"consent",
"audio_sample"
],
"type": "object"
}Input_CreateSpeechRequestBody
Complete JSON Schema
Referenced structures: Input_AudioResponseFormat2, Input_SpeechStreamFormat, Input_SpeechVoice
{
"additionalProperties": true,
"properties": {
"input": {
"type": "string"
},
"instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": "string"
},
"response_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioResponseFormat2"
},
{
"type": "null"
}
]
},
"speed": {
"type": [
"number",
"null"
]
},
"stream_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SpeechStreamFormat"
},
{
"type": "null"
}
]
},
"voice": {
"$ref": "#/components/schemas/Input_SpeechVoice"
}
},
"required": [
"model",
"input",
"voice"
],
"type": "object"
}Input_CreateTranscriptionMultipartForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_ChunkingStrategy, Input_TranscriptionInclude, Input_TranscriptionResponseFormat, Input_TranscriptionTimestampGranularity
{
"properties": {
"chunking_strategy": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ChunkingStrategy"
},
{
"type": "null"
}
]
},
"file": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"include": {
"items": {
"$ref": "#/components/schemas/Input_TranscriptionInclude"
},
"type": [
"array",
"null"
]
},
"keywords": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"known_speaker_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"known_speaker_references": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"languages": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"model": {
"type": "string"
},
"prompt": {
"type": [
"string",
"null"
]
},
"response_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TranscriptionResponseFormat"
},
{
"type": "null"
}
]
},
"stream": {
"type": [
"boolean",
"null"
]
},
"temperature": {
"type": [
"number",
"null"
]
},
"timestamp_granularities": {
"items": {
"$ref": "#/components/schemas/Input_TranscriptionTimestampGranularity"
},
"type": [
"array",
"null"
]
}
},
"required": [
"file",
"model"
],
"type": "object"
}Input_CreateTranslationMultipartForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_TranslationResponseFormat
{
"properties": {
"file": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"model": {
"type": "string"
},
"prompt": {
"type": [
"string",
"null"
]
},
"response_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TranslationResponseFormat"
},
{
"type": "null"
}
]
},
"temperature": {
"type": [
"number",
"null"
]
}
},
"required": [
"file",
"model"
],
"type": "object"
}Input_CredentialOwner
Complete JSON Schema
{
"description": "Who the credential belongs to, in the application layer's own vocabulary.\nOpaque to this crate: it copies the three columns through untouched, and\nonly the layer above knows what an organization or a team is.",
"properties": {
"organizationId": {
"default": null,
"type": [
"string",
"null"
]
},
"teamId": {
"default": null,
"type": [
"string",
"null"
]
},
"userId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_CredentialPatch
Complete JSON Schema
{
"additionalProperties": false,
"description": "Lifecycle status is not here: it is versioned against concurrent refreshes\nand changes through `Credentials::set_status`.",
"properties": {
"connectionProfileId": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"expiresAtMs": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"label": {
"default": null,
"type": [
"string",
"null"
]
},
"metadata": {
"default": null
},
"organizationId": {
"default": null,
"type": [
"string",
"null"
]
},
"proxy": {
"default": null
},
"secret": {
"default": null,
"description": "Resealed and version-bumped; peers then reload this credential alone."
},
"teamId": {
"default": null,
"type": [
"string",
"null"
]
},
"userId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_CredentialStatus
Complete JSON Schema
{
"description": "Whether the credential can still be used at all. Selection only needs this\nbit; the reason is a separate column for people.",
"oneOf": [
{
"enum": [
"active"
],
"type": "string"
},
{
"const": "dead",
"description": "Refresh was rejected definitively, the upstream revoked it, or an\noperator retired it. Waiting does not help; never selected until a\nperson logs in again.",
"type": "string"
}
]
}Input_CredentialWrite
Complete JSON Schema
{
"properties": {
"authKind": {
"description": "How the channel injects it: `api_key`, `oauth`, `cookie`, …",
"type": "string"
},
"connectionProfileId": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"expiresAtMs": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"label": {
"default": null,
"type": [
"string",
"null"
]
},
"metadata": {
"default": null
},
"organizationId": {
"default": null,
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
},
"proxy": {
"default": null
},
"secret": {
"description": "Plaintext on the way in, sealed before it reaches the database."
},
"teamId": {
"default": null,
"type": [
"string",
"null"
]
},
"userId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"providerId",
"authKind",
"secret"
],
"type": "object"
}Input_CustomCall
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"input": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"input",
"name"
],
"type": "object"
}Input_CustomOutput
Complete JSON Schema
Referenced structures: Input_InputContent
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_InputContent"
},
"type": "array"
}
]
}Input_CustomTextFormat
Complete JSON Schema
Referenced structures: Input_TextFormatType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_TextFormatType"
}
},
"required": [
"type"
],
"type": "object"
}Input_CustomTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller, Input_CustomToolFormat
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CustomToolFormat"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_CustomTool2
Complete JSON Schema
Referenced structures: Input_CustomToolFormat2
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CustomToolFormat2"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_CustomToolCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_Caller, Input_CustomToolCallType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"input": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_CustomToolCallType"
}
},
"required": [
"type",
"call_id",
"input",
"name"
],
"type": "object"
}Input_CustomToolCall2
Complete JSON Schema
Referenced structures: Input_CustomCall, Input_CustomToolCallType2
{
"additionalProperties": true,
"properties": {
"custom": {
"$ref": "#/components/schemas/Input_CustomCall"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_CustomToolCallType2"
}
},
"required": [
"id",
"custom",
"type"
],
"type": "object"
}Input_CustomToolCallOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_Caller, Input_CustomOutput, Input_CustomToolCallOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Input_CustomOutput"
},
"type": {
"$ref": "#/components/schemas/Input_CustomToolCallOutputType"
}
},
"required": [
"type",
"call_id",
"output"
],
"type": "object"
}Input_CustomToolCallOutputType
Complete JSON Schema
{
"enum": [
"custom_tool_call_output"
],
"type": "string"
}Input_CustomToolCallType
Complete JSON Schema
{
"enum": [
"custom_tool_call"
],
"type": "string"
}Input_CustomToolCallType2
Complete JSON Schema
{
"enum": [
"custom"
],
"type": "string"
}Input_CustomToolDefinition
Complete JSON Schema
Referenced structures: Input_CustomTool2, Input_CustomToolDefinitionType
{
"additionalProperties": true,
"properties": {
"custom": {
"$ref": "#/components/schemas/Input_CustomTool2"
},
"type": {
"$ref": "#/components/schemas/Input_CustomToolDefinitionType"
}
},
"required": [
"type",
"custom"
],
"type": "object"
}Input_CustomToolDefinitionType
Complete JSON Schema
{
"enum": [
"custom"
],
"type": "string"
}Input_CustomToolFormat
Complete JSON Schema
Referenced structures: Input_CustomTextFormat, Input_GrammarFormat
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_CustomTextFormat"
},
{
"$ref": "#/components/schemas/Input_GrammarFormat"
}
]
}Input_CustomToolFormat2
Complete JSON Schema
Referenced structures: Input_GrammarFormat2, Input_TextFormat2
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextFormat2"
},
{
"$ref": "#/components/schemas/Input_GrammarFormat2"
}
]
}Input_CustomVoice
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Input_CustomVoice2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Input_CustomVoice3
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Input_CustomizedAvatar
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"imageData": {
"type": [
"string",
"null"
]
},
"imageMimeType": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_CyberAccessProgram
Complete JSON Schema
{
"enum": [
"standard",
"daybreak_blue",
"daybreak_red"
],
"type": "string"
}Input_DataCollection
Complete JSON Schema
{
"enum": [
"deny",
"allow"
],
"type": "string"
}Input_DecisionBody
Complete JSON Schema
Referenced structures: Input_ConsentDecision
{
"properties": {
"decision": {
"$ref": "#/components/schemas/Input_ConsentDecision"
}
},
"required": [
"decision"
],
"type": "object"
}Input_DecisionChoice
Complete JSON Schema
Referenced structures: Input_DecisionChoiceValue
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"value": {
"$ref": "#/components/schemas/Input_DecisionChoiceValue"
}
},
"required": [
"value"
],
"type": "object"
}Input_DecisionChoiceValue
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}Input_DecisionContent
Complete JSON Schema
Referenced structures: Input_DecisionInputPart
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_DecisionInputPart"
},
"type": "array"
}
]
}Input_DecisionImageDetail
Complete JSON Schema
{
"enum": [
"low",
"high",
"auto",
"original"
],
"type": "string"
}Input_DecisionInput
Complete JSON Schema
Referenced structures: Input_DecisionInputMessage
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_DecisionInputMessage"
},
"type": "array"
}
]
}Input_DecisionInputMessage
Complete JSON Schema
Referenced structures: Input_DecisionContent, Input_DecisionMessageType, Input_DecisionRole
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_DecisionContent"
},
"role": {
"$ref": "#/components/schemas/Input_DecisionRole"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_DecisionMessageType"
},
{
"type": "null"
}
]
}
},
"required": [
"role",
"content"
],
"type": "object"
}Input_DecisionInputPart
Complete JSON Schema
Referenced structures: Input_DecisionImageDetail
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"const": "input_text",
"type": "string"
}
},
"required": [
"type",
"text"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_DecisionImageDetail"
},
{
"type": "null"
}
]
},
"image_url": {
"type": "string"
},
"type": {
"const": "input_image",
"type": "string"
}
},
"required": [
"type",
"image_url"
],
"type": "object"
}
]
}Input_DecisionMessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Input_DecisionQuestion
Complete JSON Schema
Referenced structures: Input_DecisionChoice, Input_DecisionScoreLevel
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"const": "predicate",
"type": "string"
}
},
"required": [
"type",
"instructions"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"choices": {
"items": {
"$ref": "#/components/schemas/Input_DecisionChoice"
},
"type": "array"
},
"instructions": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"const": "choice",
"type": "string"
}
},
"required": [
"type",
"instructions",
"choices"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": "string"
},
"levels": {
"items": {
"$ref": "#/components/schemas/Input_DecisionScoreLevel"
},
"type": "array"
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"const": "score",
"type": "string"
}
},
"required": [
"type",
"instructions",
"levels"
],
"type": "object"
}
]
}Input_DecisionRole
Complete JSON Schema
{
"enum": [
"user"
],
"type": "string"
}Input_DecisionScoreLevel
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
}Input_DefaultFallbacks
Complete JSON Schema
{
"enum": [
"default"
],
"type": "string"
}Input_Delivery
Complete JSON Schema
{
"enum": [
"DELIVERY_UNSPECIFIED",
"INLINE",
"URI"
],
"type": "string"
}Input_DeveloperMessage
Complete JSON Schema
Referenced structures: Input_DeveloperRole, Input_StringOrTextParts
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_StringOrTextParts"
},
"name": {
"type": [
"string",
"null"
]
},
"role": {
"$ref": "#/components/schemas/Input_DeveloperRole"
}
},
"required": [
"role",
"content"
],
"type": "object"
}Input_DeveloperRole
Complete JSON Schema
{
"enum": [
"developer"
],
"type": "string"
}Input_DeviceCodeRequest
Complete JSON Schema
{
"description": "RFC 8628 §3.1.",
"properties": {
"client_id": {
"default": "",
"type": "string"
},
"scope": {
"default": "",
"type": "string"
}
},
"type": "object"
}Input_DeviceDecisionBody
Complete JSON Schema
Referenced structures: Input_ConsentDecision
{
"properties": {
"decision": {
"$ref": "#/components/schemas/Input_ConsentDecision"
},
"userCode": {
"type": "string"
}
},
"required": [
"userCode",
"decision"
],
"type": "object"
}Input_DeviceStart
Complete JSON Schema
Referenced structures: Input_CredentialOwner
{
"properties": {
"label": {
"default": null,
"type": [
"string",
"null"
]
},
"owner": {
"$ref": "#/components/schemas/Input_CredentialOwner",
"default": {
"organizationId": null,
"teamId": null,
"userId": null
}
},
"providerId": {
"type": "string"
}
},
"required": [
"providerId"
],
"type": "object"
}Input_DiagnosticsParam
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"previous_message_id": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_DirectCaller
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_DirectCaller2
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_DiscoverBody
Complete JSON Schema
{
"description": "The two arguments `discover_models` takes. It is a request shape rather\nthan a DTO because the sdk's own signature is two arguments — there is\nnothing to mirror.",
"properties": {
"credentialId": {
"default": null,
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
}
},
"required": [
"providerId"
],
"type": "object"
}Input_DocumentBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_CitationsConfig, Input_DocumentBlockType, Input_DocumentSource
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"citations": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CitationsConfig"
},
{
"type": "null"
}
]
},
"context": {
"type": [
"string",
"null"
]
},
"source": {
"$ref": "#/components/schemas/Input_DocumentSource"
},
"title": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_DocumentBlockType"
}
},
"required": [
"type",
"source"
],
"type": "object"
}Input_DocumentBlockType
Complete JSON Schema
{
"enum": [
"document"
],
"type": "string"
}Input_DocumentContent
Complete JSON Schema
Referenced structures: Input_DocumentContentBlock
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_DocumentContentBlock"
},
"type": "array"
}
]
}Input_DocumentContentBlock
Complete JSON Schema
Referenced structures: Input_ImageBlock, Input_TextBlock
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextBlock"
},
{
"$ref": "#/components/schemas/Input_ImageBlock"
}
]
}Input_DocumentSource
Complete JSON Schema
Referenced structures: Input_ContentSource, Input_FileSource, Input_PdfBase64Source, Input_PlainTextSource, Input_UrlSource
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_PdfBase64Source",
"properties": {
"type": {
"const": "base64",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_PlainTextSource",
"properties": {
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_UrlSource",
"properties": {
"type": {
"const": "url",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_FileSource",
"properties": {
"type": {
"const": "file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ContentSource",
"properties": {
"type": {
"const": "content",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_DomainSecret
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"domain": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"domain",
"name",
"value"
],
"type": "object"
}Input_DoubleClickAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"x",
"y",
"keys"
],
"type": "object"
}Input_DragAction
Complete JSON Schema
Referenced structures: Input_Coordinate
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"path": {
"items": {
"$ref": "#/components/schemas/Input_Coordinate"
},
"type": "array"
}
},
"required": [
"path"
],
"type": "object"
}Input_DynamicRetrievalConfig
Complete JSON Schema
Referenced structures: Input_RetrievalMode
{
"additionalProperties": true,
"properties": {
"dynamicThreshold": {
"format": "double",
"type": [
"number",
"null"
]
},
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RetrievalMode"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_EasyInputMessage
Complete JSON Schema
Referenced structures: Input_Agent, Input_MessageContent, Input_MessagePhase, Input_MessageRole, Input_MessageType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_MessageContent"
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MessagePhase"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Input_MessageRole"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MessageType"
},
{
"type": "null"
}
]
}
},
"required": [
"content",
"role"
],
"type": "object"
}Input_EditImageJsonBody
Complete JSON Schema
Referenced structures: Input_EditedImageQuality, Input_EditedImageSize, Input_ImageBackground2, Input_ImageModeration, Input_ImageOutputFormat2, Input_ImageReference, Input_InputFidelity2
{
"additionalProperties": true,
"properties": {
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageBackground2"
},
{
"type": "null"
}
]
},
"images": {
"items": {
"$ref": "#/components/schemas/Input_ImageReference"
},
"type": "array"
},
"input_fidelity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InputFidelity2"
},
{
"type": "null"
}
]
},
"mask": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageReference"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageModeration"
},
{
"type": "null"
}
]
},
"n": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output_compression": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageOutputFormat2"
},
{
"type": "null"
}
]
},
"partial_images": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"prompt": {
"type": "string"
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_EditedImageQuality"
},
{
"type": "null"
}
]
},
"size": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_EditedImageSize"
},
{
"type": "null"
}
]
},
"stream": {
"type": [
"boolean",
"null"
]
},
"user": {
"type": [
"string",
"null"
]
}
},
"required": [
"images",
"prompt"
],
"type": "object"
}Input_EditImageMultipartForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_ImageBackground2, Input_ImageOutputFormat2, Input_ImageResponseFormat2, Input_InputFidelity2, Input_MultipartImageQuality
{
"properties": {
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageBackground2"
},
{
"type": "null"
}
]
},
"image": {
"items": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"type": "array"
},
"input_fidelity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InputFidelity2"
},
{
"type": "null"
}
]
},
"mask": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BinaryPart"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"n": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output_compression": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageOutputFormat2"
},
{
"type": "null"
}
]
},
"partial_images": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"prompt": {
"type": "string"
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MultipartImageQuality"
},
{
"type": "null"
}
]
},
"response_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageResponseFormat2"
},
{
"type": "null"
}
]
},
"size": {
"type": [
"string",
"null"
]
},
"stream": {
"type": [
"boolean",
"null"
]
},
"user": {
"type": [
"string",
"null"
]
}
},
"required": [
"image",
"prompt"
],
"type": "object"
}Input_EditedImageQuality
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"auto",
"xhigh",
"max"
],
"type": "string"
}Input_EditedImageSize
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"auto",
"1024x1024",
"1536x1024",
"1024x1536"
],
"type": "string"
},
{
"type": "string"
}
]
}Input_Effort
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"xhigh",
"max"
],
"type": "string"
}Input_EmbedContentConfig
Complete JSON Schema
Referenced structures: Input_GeminiTaskType
{
"additionalProperties": true,
"properties": {
"audioTrackExtraction": {
"type": [
"boolean",
"null"
]
},
"autoTruncate": {
"type": [
"boolean",
"null"
]
},
"documentOcr": {
"type": [
"boolean",
"null"
]
},
"outputDimensionality": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"taskType": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GeminiTaskType"
},
{
"type": "null"
}
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_EmbedContentRequestBody
Complete JSON Schema
Referenced structures: Input_Content, Input_EmbedContentConfig, Input_GeminiTaskType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_Content"
},
"embedContentConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_EmbedContentConfig"
},
{
"type": "null"
}
]
},
"outputDimensionality": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"taskType": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GeminiTaskType"
},
{
"type": "null"
}
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"required": [
"content"
],
"type": "object"
}Input_EmbeddedGenerateContentRequest
Complete JSON Schema
Referenced structures: Input_Content, Input_GenerationConfig, Input_SafetySetting, Input_ServiceTier, Input_Tool3, Input_ToolConfig
{
"additionalProperties": true,
"description": "Full `GenerateContentRequest` object accepted inside CountTokens. Its\n`model` is part of this embedded Batch API object; standalone REST\ngeneration keeps model in its path.",
"properties": {
"cachedContent": {
"type": [
"string",
"null"
]
},
"contents": {
"items": {
"$ref": "#/components/schemas/Input_Content"
},
"type": "array"
},
"generationConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GenerationConfig"
},
{
"type": "null"
}
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"model": {
"description": "Required by the Batch API `GenerateContentRequest` embedded in CountTokens.",
"type": "string"
},
"safetySettings": {
"items": {
"$ref": "#/components/schemas/Input_SafetySetting"
},
"type": [
"array",
"null"
]
},
"serviceTier": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ServiceTier"
},
{
"type": "null"
}
]
},
"store": {
"type": [
"boolean",
"null"
]
},
"systemInstruction": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Content"
},
{
"type": "null"
}
]
},
"toolConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolConfig"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool3"
},
"type": [
"array",
"null"
]
}
},
"required": [
"model",
"contents"
],
"type": "object"
}Input_EmbeddingEncodingFormat
Complete JSON Schema
{
"enum": [
"float",
"base64"
],
"type": "string"
}Input_EmbeddingInput
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
{
"items": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"type": "array"
}
]
}Input_EncryptedCodeExecutionResult
Complete JSON Schema
Referenced structures: Input_CodeExecutionOutput, Input_EncryptedCodeExecutionResultType
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_CodeExecutionOutput"
},
"type": "array"
},
"encrypted_stdout": {
"type": "string"
},
"return_code": {
"format": "int64",
"type": "integer"
},
"stderr": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_EncryptedCodeExecutionResultType"
}
},
"required": [
"type",
"content",
"encrypted_stdout",
"return_code",
"stderr"
],
"type": "object"
}Input_EncryptedCodeExecutionResultType
Complete JSON Schema
{
"enum": [
"encrypted_code_execution_result"
],
"type": "string"
}Input_EncryptedContent
Complete JSON Schema
Referenced structures: Input_EncryptedContentType
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_EncryptedContentType"
}
},
"required": [
"type",
"encrypted_content"
],
"type": "object"
}Input_EncryptedContentType
Complete JSON Schema
{
"enum": [
"encrypted_content"
],
"type": "string"
}Input_EndSensitivity
Complete JSON Schema
{
"enum": [
"END_SENSITIVITY_UNSPECIFIED",
"END_SENSITIVITY_HIGH",
"END_SENSITIVITY_LOW"
],
"type": "string"
}Input_ExecutableCode
Complete JSON Schema
Referenced structures: Input_Language
{
"additionalProperties": true,
"properties": {
"code": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"language": {
"$ref": "#/components/schemas/Input_Language"
}
},
"required": [
"language",
"code"
],
"type": "object"
}Input_ExecutedToolCall
Complete JSON Schema
Referenced structures: Input_ToolResultSources
{
"additionalProperties": true,
"properties": {
"arguments": true,
"name": {
"type": "string"
},
"tool_result_sources": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolResultSources"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"arguments"
],
"type": "object"
}Input_ExportCredentialDto
Complete JSON Schema
Referenced structures: Input_SealedSecretDto
{
"description": "A credential row plus the sealed bytes behind it. The columns are flattened,\nso the object is a [`CredentialDto`] with one field added.",
"properties": {
"authKind": {
"type": "string"
},
"connectionProfileId": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"hasSecret": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"metadata": true,
"organizationId": {
"description": "Opaque to this crate: the application layer decides what owns what.",
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
},
"proxy": {
"default": null
},
"refreshExpiresAtMs": {
"description": "Read-only refresh-token expiry, projected from the sealed secret on management reads.\nNone means no expiry was reported or the secret could not be read.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"secret": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SealedSecretDto"
},
{
"type": "null"
}
],
"default": null,
"description": "The database column verbatim; null when the export omitted secrets."
},
"status": {
"description": "`active` or `dead`.",
"type": "string"
},
"statusReason": {
"type": [
"string",
"null"
]
},
"teamId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"version": {
"description": "Bumped by every secret or lifecycle write; peers reload on a change.",
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"providerId",
"authKind",
"hasSecret",
"version",
"metadata",
"status",
"enabled"
],
"type": "object"
}Input_ExportRequest
Complete JSON Schema
{
"properties": {
"includeSecrets": {
"default": false,
"description": "Whether the sealed credential blobs travel with the configuration. An\nexport without them still restores every row; the credentials simply\narrive unable to authenticate until someone logs in again.",
"type": "boolean"
}
},
"type": "object"
}Input_ExternalWebAccess
Complete JSON Schema
Referenced structures: Input_ExternalWebAccessMode
{
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/Input_ExternalWebAccessMode"
}
]
}Input_ExternalWebAccessMode
Complete JSON Schema
{
"enum": [
"cached",
"indexed",
"live"
],
"type": "string"
}Input_FallbackBlock
Complete JSON Schema
Referenced structures: Input_FallbackInfo, Input_FallbackType
{
"additionalProperties": true,
"properties": {
"from": {
"$ref": "#/components/schemas/Input_FallbackInfo"
},
"to": {
"$ref": "#/components/schemas/Input_FallbackInfo"
},
"trigger": true,
"type": {
"$ref": "#/components/schemas/Input_FallbackType"
}
},
"required": [
"type",
"from",
"to"
],
"type": "object"
}Input_FallbackCreditMode
Complete JSON Schema
{
"enum": [
"strict",
"best_effort"
],
"type": "string"
}Input_FallbackCreditToken
Complete JSON Schema
Referenced structures: Input_FallbackCreditMode
{
"additionalProperties": true,
"properties": {
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FallbackCreditMode"
},
{
"type": "null"
}
]
},
"token": {
"type": "string"
}
},
"required": [
"token"
],
"type": "object"
}Input_FallbackCreditTokenParam
Complete JSON Schema
Referenced structures: Input_FallbackCreditToken
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_FallbackCreditToken"
}
]
}Input_FallbackInfo
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
}
},
"required": [
"model"
],
"type": "object"
}Input_FallbackParam
Complete JSON Schema
Referenced structures: Input_OutputConfig, Input_Speed, Input_ThinkingConfig
{
"additionalProperties": true,
"properties": {
"max_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"model": {
"type": "string"
},
"output_config": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_OutputConfig"
},
{
"type": "null"
}
]
},
"speed": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Speed"
},
{
"type": "null"
}
]
},
"thinking": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingConfig"
},
{
"type": "null"
}
]
}
},
"required": [
"model"
],
"type": "object"
}Input_FallbackType
Complete JSON Schema
{
"enum": [
"fallback"
],
"type": "string"
}Input_FallbacksParam
Complete JSON Schema
Referenced structures: Input_DefaultFallbacks, Input_FallbackParam
{
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Input_FallbackParam"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Input_DefaultFallbacks"
}
]
}Input_File
Complete JSON Schema
Referenced structures: Input_FileSize, Input_FileSource2, Input_FileState, Input_Status, Input_VideoFileMetadata
{
"additionalProperties": true,
"properties": {
"createTime": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": [
"string",
"null"
]
},
"downloadUri": {
"type": [
"string",
"null"
]
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Status"
},
{
"type": "null"
}
]
},
"expirationTime": {
"type": [
"string",
"null"
]
},
"mimeType": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"sha256Hash": {
"type": [
"string",
"null"
]
},
"sizeBytes": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileSize"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileSource2"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileState"
},
{
"type": "null"
}
]
},
"updateTime": {
"type": [
"string",
"null"
]
},
"uri": {
"type": [
"string",
"null"
]
},
"videoMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_VideoFileMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_FileAttributeValue
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}Input_FileCitation
Complete JSON Schema
Referenced structures: Input_FileCitationType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"filename": {
"type": "string"
},
"index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Input_FileCitationType"
}
},
"required": [
"file_id",
"filename",
"index",
"type"
],
"type": "object"
}Input_FileCitationType
Complete JSON Schema
{
"enum": [
"file_citation"
],
"type": "string"
}Input_FileData
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"displayName": {
"type": [
"string",
"null"
]
},
"fileUri": {
"type": "string"
},
"mimeType": {
"type": [
"string",
"null"
]
}
},
"required": [
"fileUri"
],
"type": "object"
}Input_FileDetail
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high"
],
"type": "string"
}Input_FileExpiry
Complete JSON Schema
Referenced structures: Input_FileExpiryAnchor
{
"additionalProperties": true,
"properties": {
"anchor": {
"$ref": "#/components/schemas/Input_FileExpiryAnchor"
},
"seconds": {
"format": "int64",
"type": "integer"
}
},
"required": [
"anchor",
"seconds"
],
"type": "object"
}Input_FileExpiryAnchor
Complete JSON Schema
{
"enum": [
"created_at"
],
"type": "string"
}Input_FileOrder
Complete JSON Schema
{
"enum": [
"asc",
"desc"
],
"type": "string"
}Input_FilePart
Complete JSON Schema
Referenced structures: Input_FilePartType, Input_FileRef, Input_PromptCacheBreakpoint2
{
"additionalProperties": true,
"properties": {
"file": {
"$ref": "#/components/schemas/Input_FileRef"
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint2"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_FilePartType"
}
},
"required": [
"type",
"file"
],
"type": "object"
}Input_FilePartType
Complete JSON Schema
{
"enum": [
"file"
],
"type": "string"
}Input_FilePath
Complete JSON Schema
Referenced structures: Input_FilePathType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Input_FilePathType"
}
},
"required": [
"file_id",
"index",
"type"
],
"type": "object"
}Input_FilePathType
Complete JSON Schema
{
"enum": [
"file_path"
],
"type": "string"
}Input_FileRef
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"file_data": {
"type": [
"string",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_FileSearch
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"fileSearchStoreNames": {
"items": {
"type": "string"
},
"type": "array"
},
"metadataFilter": {
"type": [
"string",
"null"
]
},
"topK": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"fileSearchStoreNames"
],
"type": "object"
}Input_FileSearchCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_FileSearchCallType, Input_FileSearchResult, Input_FileSearchStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"queries": {
"items": {
"type": "string"
},
"type": "array"
},
"results": {
"items": {
"$ref": "#/components/schemas/Input_FileSearchResult"
},
"type": [
"array",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Input_FileSearchStatus"
},
"type": {
"$ref": "#/components/schemas/Input_FileSearchCallType"
}
},
"required": [
"type",
"id",
"queries",
"status"
],
"type": "object"
}Input_FileSearchCallType
Complete JSON Schema
{
"enum": [
"file_search_call"
],
"type": "string"
}Input_FileSearchFilter
Complete JSON Schema
Referenced structures: Input_ComparisonFilter, Input_CompoundFilter
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ComparisonFilter"
},
{
"$ref": "#/components/schemas/Input_CompoundFilter"
}
]
}Input_FileSearchResult
Complete JSON Schema
Referenced structures: Input_FileAttributeValue
{
"additionalProperties": true,
"properties": {
"attributes": {
"additionalProperties": {
"$ref": "#/components/schemas/Input_FileAttributeValue"
},
"type": [
"object",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"score": {
"type": [
"number",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_FileSearchStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"searching",
"completed",
"incomplete",
"failed"
],
"type": "string"
}Input_FileSearchTool
Complete JSON Schema
Referenced structures: Input_FileSearchFilter, Input_RankingOptions
{
"additionalProperties": true,
"properties": {
"filters": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileSearchFilter"
},
{
"type": "null"
}
]
},
"max_num_results": {
"type": [
"number",
"null"
]
},
"ranking_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RankingOptions"
},
{
"type": "null"
}
]
},
"vector_store_ids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"vector_store_ids"
],
"type": "object"
}Input_FileSize
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"format": "int64",
"type": "integer"
}
],
"description": "ProtoJSON int64 values encode as strings; parsers also accept JSON integers."
}Input_FileSource
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
}
},
"required": [
"file_id"
],
"type": "object"
}Input_FileSource2
Complete JSON Schema
{
"enum": [
"SOURCE_UNSPECIFIED",
"UPLOADED",
"GENERATED",
"REGISTERED"
],
"type": "string"
}Input_FileState
Complete JSON Schema
{
"enum": [
"STATE_UNSPECIFIED",
"PROCESSING",
"ACTIVE",
"FAILED"
],
"type": "string"
}Input_FilterArrayValue
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}Input_FilterValue
Complete JSON Schema
Referenced structures: Input_FilterArrayValue
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"items": {
"$ref": "#/components/schemas/Input_FilterArrayValue"
},
"type": "array"
}
]
}Input_FinanceAssetType
Complete JSON Schema
{
"enum": [
"equity",
"fund",
"crypto",
"index"
],
"type": "string"
}Input_FinanceOperation
Complete JSON Schema
Referenced structures: Input_FinanceAssetType
{
"additionalProperties": true,
"properties": {
"market": {
"type": [
"string",
"null"
]
},
"ticker": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_FinanceAssetType"
}
},
"required": [
"ticker",
"type"
],
"type": "object"
}Input_FindOperation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"pattern": {
"type": "string"
},
"ref_id": {
"type": "string"
}
},
"required": [
"ref_id",
"pattern"
],
"type": "object"
}Input_FunctionCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_Caller, Input_FunctionCallType, Input_ItemStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"async": {
"type": [
"boolean",
"null"
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"namespace": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_FunctionCallType"
}
},
"required": [
"type",
"arguments",
"call_id",
"name"
],
"type": "object"
}Input_FunctionCall2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"args": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_FunctionCall3
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"arguments": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"arguments",
"name"
],
"type": "object"
}Input_FunctionCallChoice
Complete JSON Schema
Referenced structures: Input_FunctionCallMode, Input_LegacyFunctionChoice
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionCallMode"
},
{
"$ref": "#/components/schemas/Input_LegacyFunctionChoice"
}
]
}Input_FunctionCallMode
Complete JSON Schema
{
"enum": [
"none",
"auto"
],
"type": "string"
}Input_FunctionCallOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_Caller, Input_FunctionCallOutputType, Input_FunctionOutput, Input_ItemStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": [
"string",
"null"
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"namespace": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Input_FunctionOutput"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_FunctionCallOutputType"
}
},
"required": [
"type",
"output"
],
"type": "object"
}Input_FunctionCallOutputBody
Complete JSON Schema
Referenced structures: Input_FunctionCallOutputContentItem
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_FunctionCallOutputContentItem"
},
"type": "array"
}
]
}Input_FunctionCallOutputContentItem
Complete JSON Schema
Referenced structures: Input_FunctionCallOutputContentItemEncryptedContent, Input_FunctionCallOutputContentItemInputAudio, Input_FunctionCallOutputContentItemInputImage, Input_FunctionCallOutputContentItemInputText
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_FunctionCallOutputContentItemInputText",
"properties": {
"type": {
"const": "input_text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_FunctionCallOutputContentItemInputImage",
"properties": {
"type": {
"const": "input_image",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_FunctionCallOutputContentItemInputAudio",
"properties": {
"type": {
"const": "input_audio",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_FunctionCallOutputContentItemEncryptedContent",
"properties": {
"type": {
"const": "encrypted_content",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_FunctionCallOutputContentItemEncryptedContent
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
}
},
"required": [
"encrypted_content"
],
"type": "object"
}Input_FunctionCallOutputContentItemInputAudio
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"audio_url": {
"type": "string"
}
},
"required": [
"audio_url"
],
"type": "object"
}Input_FunctionCallOutputContentItemInputImage
Complete JSON Schema
Referenced structures: Input_ImageDetail3
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageDetail3"
},
{
"type": "null"
}
]
},
"image_url": {
"type": "string"
}
},
"required": [
"image_url"
],
"type": "object"
}Input_FunctionCallOutputContentItemInputText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_FunctionCallOutputType
Complete JSON Schema
{
"enum": [
"function_call_output"
],
"type": "string"
}Input_FunctionCallType
Complete JSON Schema
{
"enum": [
"function_call"
],
"type": "string"
}Input_FunctionCallingConfig
Complete JSON Schema
Referenced structures: Input_FunctionCallingMode
{
"additionalProperties": true,
"properties": {
"allowedFunctionNames": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionCallingMode"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_FunctionCallingMode
Complete JSON Schema
{
"enum": [
"MODE_UNSPECIFIED",
"AUTO",
"ANY",
"NONE",
"VALIDATED"
],
"type": "string"
}Input_FunctionDeclaration
Complete JSON Schema
Referenced structures: Input_Behavior, Input_Schema
{
"additionalProperties": true,
"properties": {
"behavior": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Behavior"
},
{
"type": "null"
}
]
},
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"parameters": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Schema"
},
{
"type": "null"
}
]
},
"parametersJsonSchema": true,
"response": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Schema"
},
{
"type": "null"
}
]
},
"responseJsonSchema": true
},
"required": [
"name",
"description"
],
"type": "object"
}Input_FunctionDefinition
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"parameters": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"strict": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_FunctionMessage
Complete JSON Schema
Referenced structures: Input_FunctionRole
{
"additionalProperties": true,
"properties": {
"content": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"role": {
"$ref": "#/components/schemas/Input_FunctionRole"
}
},
"required": [
"role",
"name",
"content"
],
"type": "object"
}Input_FunctionOutput
Complete JSON Schema
Referenced structures: Input_FunctionOutputContent
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_FunctionOutputContent"
},
"type": "array"
}
]
}Input_FunctionOutputContent
Complete JSON Schema
Referenced structures: Input_FunctionOutputFile, Input_FunctionOutputImage, Input_FunctionOutputText
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionOutputText"
},
{
"$ref": "#/components/schemas/Input_FunctionOutputImage"
},
{
"$ref": "#/components/schemas/Input_FunctionOutputFile"
}
]
}Input_FunctionOutputFile
Complete JSON Schema
Referenced structures: Input_FileDetail, Input_PromptCacheBreakpoint, Input_ResponseInputFileType
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileDetail"
},
{
"type": "null"
}
]
},
"file_data": {
"type": [
"string",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"file_url": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputFileType"
}
},
"required": [
"type"
],
"type": "object"
}Input_FunctionOutputImage
Complete JSON Schema
Referenced structures: Input_ImageDetail, Input_PromptCacheBreakpoint, Input_ResponseInputImageType
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageDetail"
},
{
"type": "null"
}
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputImageType"
}
},
"required": [
"type"
],
"type": "object"
}Input_FunctionOutputText
Complete JSON Schema
Referenced structures: Input_PromptCacheBreakpoint, Input_ResponseInputTextType
{
"additionalProperties": true,
"properties": {
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_FunctionResponse
Complete JSON Schema
Referenced structures: Input_FunctionResponsePart, Input_Scheduling
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"parts": {
"items": {
"$ref": "#/components/schemas/Input_FunctionResponsePart"
},
"type": [
"array",
"null"
]
},
"response": {
"additionalProperties": true,
"type": "object"
},
"scheduling": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Scheduling"
},
{
"type": "null"
}
]
},
"willContinue": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"response"
],
"type": "object"
}Input_FunctionResponsePart
Complete JSON Schema
Referenced structures: Input_Blob
{
"additionalProperties": true,
"properties": {
"inlineData": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Blob"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_FunctionRole
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Input_FunctionTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"output_schema": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"parameters": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"strict": {
"default": null,
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"parameters"
],
"type": "object"
}Input_FunctionTool2
Complete JSON Schema
Referenced structures: Input_FunctionDefinition, Input_FunctionToolType
{
"additionalProperties": true,
"properties": {
"function": {
"$ref": "#/components/schemas/Input_FunctionDefinition"
},
"type": {
"$ref": "#/components/schemas/Input_FunctionToolType"
}
},
"required": [
"type",
"function"
],
"type": "object"
}Input_FunctionToolType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Input_GeminiTaskType
Complete JSON Schema
{
"enum": [
"TASK_TYPE_UNSPECIFIED",
"RETRIEVAL_QUERY",
"RETRIEVAL_DOCUMENT",
"SEMANTIC_SIMILARITY",
"CLASSIFICATION",
"CLUSTERING",
"QUESTION_ANSWERING",
"FACT_VERIFICATION",
"CODE_RETRIEVAL_QUERY"
],
"type": "string"
}Input_GenerateContentRequestBody
Complete JSON Schema
Referenced structures: Input_AccessPrograms, Input_ContextManagement, Input_ConversationParam, Input_GenerateTruncation, Input_Input, Input_MultiAgentConfig, Input_PromptCacheOptions, Input_PromptCacheRetention, Input_ReasoningConfig, Input_ResponseIncludable, Input_ResponseModeration, Input_ResponsePrompt, Input_ServiceTier2, Input_StreamOptions, Input_TextConfig, Input_Tool, Input_ToolChoice
{
"additionalProperties": true,
"properties": {
"access_programs": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AccessPrograms"
},
{
"type": "null"
}
]
},
"background": {
"type": [
"boolean",
"null"
]
},
"context_management": {
"items": {
"$ref": "#/components/schemas/Input_ContextManagement"
},
"type": [
"array",
"null"
]
},
"conversation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ConversationParam"
},
{
"type": "null"
}
]
},
"include": {
"items": {
"$ref": "#/components/schemas/Input_ResponseIncludable"
},
"type": [
"array",
"null"
]
},
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Input"
},
{
"type": "null"
}
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_tool_calls": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseModeration"
},
{
"type": "null"
}
]
},
"multi_agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MultiAgentConfig"
},
{
"type": "null"
}
]
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"previous_response_id": {
"type": [
"string",
"null"
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponsePrompt"
},
{
"type": "null"
}
]
},
"prompt_cache_key": {
"type": [
"string",
"null"
]
},
"prompt_cache_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheOptions"
},
{
"type": "null"
}
]
},
"prompt_cache_retention": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheRetention"
},
{
"type": "null"
}
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningConfig"
},
{
"type": "null"
}
]
},
"safety_identifier": {
"type": [
"string",
"null"
]
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ServiceTier2"
},
{
"type": "null"
}
]
},
"store": {
"type": [
"boolean",
"null"
]
},
"stream": {
"type": [
"boolean",
"null"
]
},
"stream_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_StreamOptions"
},
{
"type": "null"
}
]
},
"temperature": {
"type": [
"number",
"null"
]
},
"text": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextConfig"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoice"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool"
},
"type": [
"array",
"null"
]
},
"top_logprobs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"top_p": {
"type": [
"number",
"null"
]
},
"truncation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GenerateTruncation"
},
{
"type": "null"
}
]
},
"user": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_GenerateContentRequestBody2
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_CompactionConfig, Input_ContainerParam, Input_ContextManagementConfig, Input_DiagnosticsParam, Input_FallbackCreditTokenParam, Input_FallbacksParam, Input_JsonOutputFormat, Input_McpServerUrlDefinition, Input_Message, Input_Metadata, Input_OutputConfig, Input_ServiceTier3, Input_Speed, Input_SystemPrompt, Input_ThinkingConfig, Input_ToolChoice2, Input_ToolUnion
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"compaction": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CompactionConfig"
},
{
"type": "null"
}
]
},
"container": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ContainerParam"
},
{
"type": "null"
}
]
},
"context_management": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ContextManagementConfig"
},
{
"type": "null"
}
]
},
"diagnostics": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_DiagnosticsParam"
},
{
"type": "null"
}
]
},
"fallback_credit_token": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FallbackCreditTokenParam"
},
{
"type": "null"
}
]
},
"fallbacks": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FallbacksParam"
},
{
"type": "null"
}
]
},
"inference_geo": {
"type": [
"string",
"null"
]
},
"max_tokens": {
"format": "int64",
"type": "integer"
},
"mcp_servers": {
"items": {
"$ref": "#/components/schemas/Input_McpServerUrlDefinition"
},
"type": [
"array",
"null"
]
},
"messages": {
"items": {
"$ref": "#/components/schemas/Input_Message"
},
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Metadata"
},
{
"type": "null"
}
]
},
"model": {
"type": "string"
},
"output_config": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_OutputConfig"
},
{
"type": "null"
}
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_JsonOutputFormat"
},
{
"type": "null"
}
]
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ServiceTier3"
},
{
"type": "null"
}
]
},
"speed": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Speed"
},
{
"type": "null"
}
]
},
"stop_sequences": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"stream": {
"type": [
"boolean",
"null"
]
},
"system": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SystemPrompt"
},
{
"type": "null"
}
]
},
"thinking": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingConfig"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoice2"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_ToolUnion"
},
"type": [
"array",
"null"
]
}
},
"required": [
"max_tokens",
"messages",
"model"
],
"type": "object"
}Input_GenerateContentRequestBody3
Complete JSON Schema
Referenced structures: Input_Content, Input_GenerationConfig, Input_SafetySetting, Input_ServiceTier, Input_Tool3, Input_ToolConfig
{
"additionalProperties": true,
"properties": {
"cachedContent": {
"type": [
"string",
"null"
]
},
"contents": {
"items": {
"$ref": "#/components/schemas/Input_Content"
},
"type": "array"
},
"continuationToken": {
"description": "Opaque token from a previous hop; contents must match the original request.",
"type": [
"string",
"null"
]
},
"generationConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GenerationConfig"
},
{
"type": "null"
}
]
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"safetySettings": {
"items": {
"$ref": "#/components/schemas/Input_SafetySetting"
},
"type": [
"array",
"null"
]
},
"serviceTier": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ServiceTier"
},
{
"type": "null"
}
]
},
"store": {
"type": [
"boolean",
"null"
]
},
"systemInstruction": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Content"
},
{
"type": "null"
}
]
},
"toolConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolConfig"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool3"
},
"type": [
"array",
"null"
]
}
},
"required": [
"contents"
],
"type": "object"
}Input_GenerateContentRequestBody4
Complete JSON Schema
Referenced structures: Input_ChatAudioParam, Input_ChatMessage, Input_ChatTool, Input_FunctionCallChoice, Input_LegacyFunction, Input_Modality2, Input_Moderation2, Input_Prediction, Input_PromptCacheOptions2, Input_PromptCacheRetention2, Input_ReasoningEffort2, Input_ResponseFormat, Input_ServiceTier4, Input_Stop, Input_StreamOptions2, Input_ToolChoice3, Input_Verbosity, Input_WebSearchOptions
{
"additionalProperties": true,
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ChatAudioParam"
},
{
"type": "null"
}
]
},
"frequency_penalty": {
"format": "double",
"type": [
"number",
"null"
]
},
"function_call": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionCallChoice"
},
{
"type": "null"
}
]
},
"functions": {
"items": {
"$ref": "#/components/schemas/Input_LegacyFunction"
},
"type": [
"array",
"null"
]
},
"logit_bias": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"type": [
"object",
"null"
]
},
"logprobs": {
"type": [
"boolean",
"null"
]
},
"max_completion_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"messages": {
"items": {
"$ref": "#/components/schemas/Input_ChatMessage"
},
"type": "array"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"modalities": {
"items": {
"$ref": "#/components/schemas/Input_Modality2"
},
"type": [
"array",
"null"
]
},
"model": {
"type": "string"
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Moderation2"
},
{
"type": "null"
}
]
},
"n": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"prediction": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Prediction"
},
{
"type": "null"
}
]
},
"presence_penalty": {
"format": "double",
"type": [
"number",
"null"
]
},
"prompt_cache_key": {
"type": [
"string",
"null"
]
},
"prompt_cache_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheOptions2"
},
{
"type": "null"
}
]
},
"prompt_cache_retention": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheRetention2"
},
{
"type": "null"
}
]
},
"reasoning_effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningEffort2"
},
{
"type": "null"
}
]
},
"response_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseFormat"
},
{
"type": "null"
}
]
},
"safety_identifier": {
"type": [
"string",
"null"
]
},
"seed": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ServiceTier4"
},
{
"type": "null"
}
]
},
"stop": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Stop"
},
{
"type": "null"
}
]
},
"store": {
"type": [
"boolean",
"null"
]
},
"stream": {
"type": [
"boolean",
"null"
]
},
"stream_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_StreamOptions2"
},
{
"type": "null"
}
]
},
"temperature": {
"format": "double",
"type": [
"number",
"null"
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoice3"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_ChatTool"
},
"type": [
"array",
"null"
]
},
"top_logprobs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"top_p": {
"format": "double",
"type": [
"number",
"null"
]
},
"user": {
"type": [
"string",
"null"
]
},
"verbosity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Verbosity"
},
{
"type": "null"
}
]
},
"web_search_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_WebSearchOptions"
},
{
"type": "null"
}
]
}
},
"required": [
"messages",
"model"
],
"type": "object"
}Input_GenerateTruncation
Complete JSON Schema
{
"enum": [
"auto",
"disabled"
],
"type": "string"
}Input_GenerationConfig
Complete JSON Schema
Referenced structures: Input_AudioTranscriptionConfig, Input_GenerationMediaResolution, Input_ImageConfig, Input_Modality, Input_ResponseFormatConfig, Input_Schema, Input_SpeechConfig, Input_ThinkingConfig2, Input_TranslationConfig
{
"additionalProperties": true,
"properties": {
"_responseJsonSchema": true,
"audioTranscriptionConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscriptionConfig"
},
{
"type": "null"
}
]
},
"candidateCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"enableAffectiveDialog": {
"type": [
"boolean",
"null"
]
},
"enableEnhancedCivicAnswers": {
"type": [
"boolean",
"null"
]
},
"frequencyPenalty": {
"format": "double",
"type": [
"number",
"null"
]
},
"imageConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageConfig"
},
{
"type": "null"
}
]
},
"logprobs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxOutputTokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"mediaResolution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GenerationMediaResolution"
},
{
"type": "null"
}
]
},
"presencePenalty": {
"format": "double",
"type": [
"number",
"null"
]
},
"responseFormat": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseFormatConfig"
},
{
"type": "null"
}
]
},
"responseJsonSchema": true,
"responseLogprobs": {
"type": [
"boolean",
"null"
]
},
"responseMimeType": {
"type": [
"string",
"null"
]
},
"responseModalities": {
"items": {
"$ref": "#/components/schemas/Input_Modality"
},
"type": [
"array",
"null"
]
},
"responseSchema": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Schema"
},
{
"type": "null"
}
]
},
"seed": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"speechConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SpeechConfig"
},
{
"type": "null"
}
]
},
"stopSequences": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"temperature": {
"format": "double",
"type": [
"number",
"null"
]
},
"thinkingConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingConfig2"
},
{
"type": "null"
}
]
},
"topK": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"topP": {
"format": "double",
"type": [
"number",
"null"
]
},
"translationConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TranslationConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_GenerationMediaResolution
Complete JSON Schema
{
"enum": [
"MEDIA_RESOLUTION_UNSPECIFIED",
"MEDIA_RESOLUTION_LOW",
"MEDIA_RESOLUTION_MEDIUM",
"MEDIA_RESOLUTION_HIGH"
],
"type": "string"
}Input_GoogleMaps
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"enableWidget": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_GoogleSearch
Complete JSON Schema
Referenced structures: Input_Interval, Input_SearchTypes
{
"additionalProperties": true,
"properties": {
"searchTypes": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchTypes"
},
{
"type": "null"
}
]
},
"timeRangeFilter": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Interval"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_GoogleSearchRetrieval
Complete JSON Schema
Referenced structures: Input_DynamicRetrievalConfig
{
"additionalProperties": true,
"properties": {
"dynamicRetrievalConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_DynamicRetrievalConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_Grammar
Complete JSON Schema
Referenced structures: Input_GrammarSyntax2
{
"additionalProperties": true,
"properties": {
"definition": {
"type": "string"
},
"syntax": {
"$ref": "#/components/schemas/Input_GrammarSyntax2"
}
},
"required": [
"definition",
"syntax"
],
"type": "object"
}Input_GrammarFormat
Complete JSON Schema
Referenced structures: Input_GrammarFormatType, Input_GrammarSyntax
{
"additionalProperties": true,
"properties": {
"definition": {
"type": "string"
},
"syntax": {
"$ref": "#/components/schemas/Input_GrammarSyntax"
},
"type": {
"$ref": "#/components/schemas/Input_GrammarFormatType"
}
},
"required": [
"definition",
"syntax",
"type"
],
"type": "object"
}Input_GrammarFormat2
Complete JSON Schema
Referenced structures: Input_Grammar, Input_GrammarFormatType2
{
"additionalProperties": true,
"properties": {
"grammar": {
"$ref": "#/components/schemas/Input_Grammar"
},
"type": {
"$ref": "#/components/schemas/Input_GrammarFormatType2"
}
},
"required": [
"type",
"grammar"
],
"type": "object"
}Input_GrammarFormatType
Complete JSON Schema
{
"enum": [
"grammar"
],
"type": "string"
}Input_GrammarFormatType2
Complete JSON Schema
{
"enum": [
"grammar"
],
"type": "string"
}Input_GrammarSyntax
Complete JSON Schema
{
"enum": [
"lark",
"regex"
],
"type": "string"
}Input_GrammarSyntax2
Complete JSON Schema
{
"enum": [
"lark",
"regex"
],
"type": "string"
}Input_HarmBlockThreshold
Complete JSON Schema
{
"enum": [
"HARM_BLOCK_THRESHOLD_UNSPECIFIED",
"BLOCK_LOW_AND_ABOVE",
"BLOCK_MEDIUM_AND_ABOVE",
"BLOCK_ONLY_HIGH",
"BLOCK_NONE",
"OFF"
],
"type": "string"
}Input_HarmCategory
Complete JSON Schema
{
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_SEXUALLY_EXPLICIT",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_CIVIC_INTEGRITY",
"HARM_CATEGORY_DEROGATORY",
"HARM_CATEGORY_TOXICITY",
"HARM_CATEGORY_VIOLENCE",
"HARM_CATEGORY_SEXUAL",
"HARM_CATEGORY_MEDICAL",
"HARM_CATEGORY_DANGEROUS",
"HARM_CATEGORY_JAILBREAK"
],
"type": "string"
}Input_HistoryConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"initialHistoryInClientContent": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_HistoryDelete
Complete JSON Schema
{
"description": "Request history rows to delete, by the ids a listing returned.",
"properties": {
"ids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"ids"
],
"type": "object"
}Input_HybridSearch
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"embedding_weight": {
"type": "number"
},
"text_weight": {
"type": "number"
}
},
"required": [
"embedding_weight",
"text_weight"
],
"type": "object"
}Input_ImageAction
Complete JSON Schema
{
"enum": [
"generate",
"edit",
"auto"
],
"type": "string"
}Input_ImageBackground
Complete JSON Schema
{
"enum": [
"transparent",
"opaque",
"auto"
],
"type": "string"
}Input_ImageBackground2
Complete JSON Schema
{
"enum": [
"transparent",
"opaque",
"auto"
],
"type": "string"
}Input_ImageBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ImageBlockType, Input_ImageSource
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"source": {
"$ref": "#/components/schemas/Input_ImageSource"
},
"type": {
"$ref": "#/components/schemas/Input_ImageBlockType"
}
},
"required": [
"type",
"source"
],
"type": "object"
}Input_ImageBlockType
Complete JSON Schema
{
"enum": [
"image"
],
"type": "string"
}Input_ImageConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"aspectRatio": {
"type": [
"string",
"null"
]
},
"imageSize": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ImageDetail
Complete JSON Schema
{
"enum": [
"low",
"high",
"auto",
"original"
],
"type": "string"
}Input_ImageDetail2
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high"
],
"type": "string"
}Input_ImageDetail3
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high",
"original"
],
"type": "string"
}Input_ImageDetail4
Complete JSON Schema
{
"description": "Source: `openai/types/responses/image_detail.py`, `ImageDetail`.",
"enum": [
"low",
"high",
"auto",
"original"
],
"type": "string"
}Input_ImageGenerationCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_ImageAction, Input_ImageBackground, Input_ImageGenerationCallError, Input_ImageGenerationCallType, Input_ImageGenerationStatus, Input_ImageOutputFormat, Input_ImageQuality
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageAction"
},
{
"type": "null"
}
]
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageBackground"
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageGenerationCallError"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageOutputFormat"
},
{
"type": "null"
}
]
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageQuality"
},
{
"type": "null"
}
]
},
"result": {
"type": [
"string",
"null"
]
},
"revised_prompt": {
"type": [
"string",
"null"
]
},
"size": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Input_ImageGenerationStatus"
},
"type": {
"$ref": "#/components/schemas/Input_ImageGenerationCallType"
}
},
"required": [
"type",
"id",
"status",
"result"
],
"type": "object"
}Input_ImageGenerationCallError
Complete JSON Schema
Referenced structures: Input_ImageModerationDetails
{
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"message": {
"type": "string"
},
"moderation_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageModerationDetails"
},
{
"type": "null"
}
]
},
"param": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"message",
"type",
"code",
"param"
],
"type": "object"
}Input_ImageGenerationCallType
Complete JSON Schema
{
"enum": [
"image_generation_call"
],
"type": "string"
}Input_ImageGenerationStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"generating",
"failed"
],
"type": "string"
}Input_ImageGenerationTool
Complete JSON Schema
Referenced structures: Input_ImageAction, Input_ImageBackground, Input_ImageOutputFormat, Input_ImageQuality, Input_InputFidelity, Input_InputImageMask, Input_Moderation
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageAction"
},
{
"type": "null"
}
]
},
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageBackground"
},
{
"type": "null"
}
]
},
"input_fidelity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InputFidelity"
},
{
"type": "null"
}
]
},
"input_image_mask": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InputImageMask"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Moderation"
},
{
"type": "null"
}
]
},
"output_compression": {
"type": [
"number",
"null"
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageOutputFormat"
},
{
"type": "null"
}
]
},
"partial_images": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageQuality"
},
{
"type": "null"
}
]
},
"size": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ImageMediaType
Complete JSON Schema
{
"enum": [
"image/jpeg",
"image/png",
"image/gif",
"image/webp"
],
"type": "string"
}Input_ImageMimeType
Complete JSON Schema
{
"enum": [
"MIME_TYPE_UNSPECIFIED",
"IMAGE_JPEG"
],
"type": "string"
}Input_ImageModeration
Complete JSON Schema
{
"enum": [
"low",
"auto"
],
"type": "string"
}Input_ImageModerationDetails
Complete JSON Schema
Referenced structures: Input_ImageModerationStage
{
"additionalProperties": true,
"properties": {
"categories": {
"items": {
"type": "string"
},
"type": "array"
},
"moderation_stage": {
"$ref": "#/components/schemas/Input_ImageModerationStage"
}
},
"required": [
"categories",
"moderation_stage"
],
"type": "object"
}Input_ImageModerationStage
Complete JSON Schema
{
"enum": [
"input",
"output",
"unknown"
],
"type": "string"
}Input_ImageOutputFormat
Complete JSON Schema
{
"enum": [
"png",
"webp",
"jpeg"
],
"type": "string"
}Input_ImageOutputFormat2
Complete JSON Schema
{
"enum": [
"png",
"jpeg",
"webp"
],
"type": "string"
}Input_ImagePart
Complete JSON Schema
Referenced structures: Input_ImagePartType, Input_ImageUrl, Input_PromptCacheBreakpoint2
{
"additionalProperties": true,
"properties": {
"image_url": {
"$ref": "#/components/schemas/Input_ImageUrl"
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint2"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ImagePartType"
}
},
"required": [
"type",
"image_url"
],
"type": "object"
}Input_ImagePartType
Complete JSON Schema
{
"enum": [
"image_url"
],
"type": "string"
}Input_ImageQuality
Complete JSON Schema
{
"enum": [
"xhigh",
"max",
"low",
"medium",
"high",
"auto"
],
"type": "string"
}Input_ImageQuality2
Complete JSON Schema
{
"enum": [
"standard",
"hd",
"low",
"medium",
"high",
"auto",
"xhigh",
"max"
],
"type": "string"
}Input_ImageReference
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ImageResponseFormat
Complete JSON Schema
Referenced structures: Input_AspectRatio, Input_Delivery, Input_ImageMimeType, Input_ImageSize
{
"additionalProperties": true,
"properties": {
"aspectRatio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AspectRatio"
},
{
"type": "null"
}
]
},
"delivery": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Delivery"
},
{
"type": "null"
}
]
},
"imageSize": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageSize"
},
{
"type": "null"
}
]
},
"mimeType": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageMimeType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ImageResponseFormat2
Complete JSON Schema
{
"enum": [
"url",
"b64_json"
],
"type": "string"
}Input_ImageSearch
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ImageSize
Complete JSON Schema
{
"enum": [
"IMAGE_SIZE_UNSPECIFIED",
"IMAGE_SIZE_FIVE_TWELVE",
"IMAGE_SIZE_ONE_K",
"IMAGE_SIZE_TWO_K",
"IMAGE_SIZE_FOUR_K"
],
"type": "string"
}Input_ImageSource
Complete JSON Schema
Referenced structures: Input_Base64Source, Input_FileSource, Input_UrlSource
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_Base64Source",
"properties": {
"type": {
"const": "base64",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_UrlSource",
"properties": {
"type": {
"const": "url",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_FileSource",
"properties": {
"type": {
"const": "file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ImageStyle
Complete JSON Schema
{
"enum": [
"vivid",
"natural"
],
"type": "string"
}Input_ImageUrl
Complete JSON Schema
Referenced structures: Input_ImageDetail2
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageDetail2"
},
{
"type": "null"
}
]
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}Input_ImportMode
Complete JSON Schema
{
"description": "What an import does with a row the destination already has under that id.",
"oneOf": [
{
"const": "merge",
"description": "Write every row of the document, leaving anything it does not mention\nalone. This is the additive mode: two deployments can be merged.",
"type": "string"
},
{
"const": "replace",
"description": "The same, and then delete every row of an exported kind that the\ndocument does not mention. The destination becomes the document.\nIdentity, usage and capture tables are never touched by it.",
"type": "string"
}
]
}Input_ImportRequest
Complete JSON Schema
Referenced structures: Input_ConfigurationExportDto, Input_ImportMode
{
"properties": {
"export": {
"$ref": "#/components/schemas/Input_ConfigurationExportDto"
},
"mode": {
"$ref": "#/components/schemas/Input_ImportMode",
"default": "merge"
},
"sourceMasterKey": {
"default": null,
"description": "The 32-byte master key the source sealed its credentials with, in\nstandard base64. With it every secret is opened and resealed under this\ninstance's codec; without it the blobs are stored verbatim, which only\nworks if both instances share a key.",
"type": [
"string",
"null"
]
}
},
"required": [
"export"
],
"type": "object"
}Input_InjectRequest
Complete JSON Schema
Referenced structures: Input_InputItem
{
"additionalProperties": true,
"properties": {
"input": {
"items": {
"$ref": "#/components/schemas/Input_InputItem"
},
"type": "array"
},
"response_id": {
"type": "string"
}
},
"required": [
"response_id",
"input"
],
"type": "object"
}Input_InlineSkill
Complete JSON Schema
Referenced structures: Input_InlineSkillSource, Input_InlineSkillType
{
"additionalProperties": true,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/Input_InlineSkillSource"
},
"type": {
"$ref": "#/components/schemas/Input_InlineSkillType"
}
},
"required": [
"description",
"name",
"source",
"type"
],
"type": "object"
}Input_InlineSkillSource
Complete JSON Schema
Referenced structures: Input_Base64SourceType, Input_ZipMediaType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"media_type": {
"$ref": "#/components/schemas/Input_ZipMediaType"
},
"type": {
"$ref": "#/components/schemas/Input_Base64SourceType"
}
},
"required": [
"data",
"media_type",
"type"
],
"type": "object"
}Input_InlineSkillType
Complete JSON Schema
{
"enum": [
"inline"
],
"type": "string"
}Input_Input
Complete JSON Schema
Referenced structures: Input_InputItem
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_InputItem"
},
"type": "array"
}
]
}Input_InputAudio
Complete JSON Schema
Referenced structures: Input_AudioFormat
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"format": {
"$ref": "#/components/schemas/Input_AudioFormat"
}
},
"required": [
"data",
"format"
],
"type": "object"
}Input_InputAudioBufferAppendEvent
Complete JSON Schema
Referenced structures: Input_InputAudioBufferAppendEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_append_event.py`, `InputAudioBufferAppendEvent`.",
"properties": {
"audio": {
"type": "string"
},
"event_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_InputAudioBufferAppendEventType"
}
},
"required": [
"audio",
"type"
],
"type": "object"
}Input_InputAudioBufferAppendEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.append"
],
"type": "string"
}Input_InputAudioBufferClearEvent
Complete JSON Schema
Referenced structures: Input_InputAudioBufferClearEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_clear_event.py`, `InputAudioBufferClearEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_InputAudioBufferClearEventType"
}
},
"required": [
"type"
],
"type": "object"
}Input_InputAudioBufferClearEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.clear"
],
"type": "string"
}Input_InputAudioBufferCommitEvent
Complete JSON Schema
Referenced structures: Input_InputAudioBufferCommitEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_commit_event.py`, `InputAudioBufferCommitEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_InputAudioBufferCommitEventType"
}
},
"required": [
"type"
],
"type": "object"
}Input_InputAudioBufferCommitEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.commit"
],
"type": "string"
}Input_InputAudioPart
Complete JSON Schema
Referenced structures: Input_InputAudio, Input_InputAudioPartType, Input_PromptCacheBreakpoint2
{
"additionalProperties": true,
"properties": {
"input_audio": {
"$ref": "#/components/schemas/Input_InputAudio"
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint2"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_InputAudioPartType"
}
},
"required": [
"type",
"input_audio"
],
"type": "object"
}Input_InputAudioPartType
Complete JSON Schema
{
"enum": [
"input_audio"
],
"type": "string"
}Input_InputContent
Complete JSON Schema
Referenced structures: Input_ResponseInputFile, Input_ResponseInputImage, Input_ResponseInputText
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInputText"
},
{
"$ref": "#/components/schemas/Input_ResponseInputImage"
},
{
"$ref": "#/components/schemas/Input_ResponseInputFile"
}
]
}Input_InputFidelity
Complete JSON Schema
{
"enum": [
"low",
"high"
],
"type": "string"
}Input_InputFidelity2
Complete JSON Schema
{
"enum": [
"high",
"low"
],
"type": "string"
}Input_InputImageMask
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_InputItem
Complete JSON Schema
Referenced structures: Input_AdditionalTools, Input_AgentMessage, Input_ApplyPatchCall, Input_ApplyPatchCallOutput, Input_CodeInterpreterCall, Input_Compaction, Input_CompactionTrigger, Input_ComputerCall, Input_ComputerCallOutput, Input_ConfigurationUpdate, Input_CustomToolCall, Input_CustomToolCallOutput, Input_EasyInputMessage, Input_FileSearchCall, Input_FunctionCall, Input_FunctionCallOutput, Input_ImageGenerationCall, Input_InputMessage, Input_ItemReference, Input_LocalShellCall, Input_LocalShellCallOutput, Input_McpApprovalRequest, Input_McpApprovalResponse, Input_McpCall, Input_McpListTools, Input_MultiAgentCall, Input_MultiAgentCallOutput, Input_Program, Input_ProgramOutput, Input_ReasoningItem, Input_ResponseOutputMessage, Input_ShellCall, Input_ShellCallOutput, Input_ToolSearchCall, Input_ToolSearchOutput, Input_WebSearchCall
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_MultiAgentCall"
},
{
"$ref": "#/components/schemas/Input_MultiAgentCallOutput"
},
{
"$ref": "#/components/schemas/Input_AgentMessage"
},
{
"$ref": "#/components/schemas/Input_ConfigurationUpdate"
},
{
"$ref": "#/components/schemas/Input_ResponseOutputMessage"
},
{
"$ref": "#/components/schemas/Input_InputMessage"
},
{
"$ref": "#/components/schemas/Input_EasyInputMessage"
},
{
"$ref": "#/components/schemas/Input_FunctionCall"
},
{
"$ref": "#/components/schemas/Input_FunctionCallOutput"
},
{
"$ref": "#/components/schemas/Input_ReasoningItem"
},
{
"$ref": "#/components/schemas/Input_ItemReference"
},
{
"$ref": "#/components/schemas/Input_Compaction"
},
{
"$ref": "#/components/schemas/Input_ComputerCall"
},
{
"$ref": "#/components/schemas/Input_ComputerCallOutput"
},
{
"$ref": "#/components/schemas/Input_WebSearchCall"
},
{
"$ref": "#/components/schemas/Input_FileSearchCall"
},
{
"$ref": "#/components/schemas/Input_ImageGenerationCall"
},
{
"$ref": "#/components/schemas/Input_CodeInterpreterCall"
},
{
"$ref": "#/components/schemas/Input_CustomToolCall"
},
{
"$ref": "#/components/schemas/Input_CustomToolCallOutput"
},
{
"$ref": "#/components/schemas/Input_ToolSearchCall"
},
{
"$ref": "#/components/schemas/Input_ToolSearchOutput"
},
{
"$ref": "#/components/schemas/Input_AdditionalTools"
},
{
"$ref": "#/components/schemas/Input_LocalShellCall"
},
{
"$ref": "#/components/schemas/Input_LocalShellCallOutput"
},
{
"$ref": "#/components/schemas/Input_ShellCall"
},
{
"$ref": "#/components/schemas/Input_ShellCallOutput"
},
{
"$ref": "#/components/schemas/Input_ApplyPatchCall"
},
{
"$ref": "#/components/schemas/Input_ApplyPatchCallOutput"
},
{
"$ref": "#/components/schemas/Input_McpListTools"
},
{
"$ref": "#/components/schemas/Input_McpApprovalRequest"
},
{
"$ref": "#/components/schemas/Input_McpApprovalResponse"
},
{
"$ref": "#/components/schemas/Input_McpCall"
},
{
"$ref": "#/components/schemas/Input_CompactionTrigger"
},
{
"$ref": "#/components/schemas/Input_Program"
},
{
"$ref": "#/components/schemas/Input_ProgramOutput"
}
]
}Input_InputMessage
Complete JSON Schema
Referenced structures: Input_Agent, Input_InputContent, Input_InputMessageRole, Input_MessageType, Input_OutputMessageStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Input_InputContent"
},
"type": "array"
},
"role": {
"$ref": "#/components/schemas/Input_InputMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_OutputMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MessageType"
},
{
"type": "null"
}
]
}
},
"required": [
"content",
"role"
],
"type": "object"
}Input_InputMessageRole
Complete JSON Schema
{
"enum": [
"user",
"system",
"developer"
],
"type": "string"
}Input_InputTokensThreshold
Complete JSON Schema
Referenced structures: Input_InputTokensType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_InputTokensType"
},
"value": {
"format": "int64",
"type": "integer"
}
},
"required": [
"type",
"value"
],
"type": "object"
}Input_InputTokensType
Complete JSON Schema
{
"enum": [
"input_tokens"
],
"type": "string"
}Input_InstanceSettingsDto
Complete JSON Schema
{
"additionalProperties": false,
"description": "Identity, network, execution limits and maintenance. `config_revision` is\nread-only: it is the write path's own counter.",
"properties": {
"allowedHeaders": {
"default": []
},
"alwaysSecureCookie": {
"default": false,
"description": "Absent in an export from a build without it, which reads as off.",
"type": "boolean"
},
"capturePayloadMaxMb": {
"default": 2048,
"format": "int64",
"type": [
"integer",
"null"
]
},
"capturePayloadRetentionDays": {
"default": 7,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"configRevision": {
"format": "int64",
"type": "integer"
},
"connectionProfileId": {
"type": [
"string",
"null"
]
},
"corsOrigins": true,
"defaultVocabularyFileId": {
"type": [
"string",
"null"
]
},
"enableAutoUpdateCheck": {
"type": "boolean"
},
"enableSettlement": {
"type": "boolean"
},
"enableTokenizerDownload": {
"type": "boolean"
},
"enableTokenizerVocabs": {
"type": "boolean"
},
"enableUsage": {
"type": "boolean"
},
"hasTokenizerAuthToken": {
"description": "The vocabulary source token is sealed like a credential secret; only\nits presence is reported.",
"type": "boolean"
},
"instanceName": {
"type": "string"
},
"maxAttempts": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"maxDatabaseSizeMb": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxMultipartParts": {
"default": 64,
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"maxRequestBodyBytes": {
"default": 52428800,
"format": "int64",
"type": "integer"
},
"maxResponseBodyBytes": {
"default": 268435456,
"format": "int64",
"type": "integer"
},
"maxStreamEventBytes": {
"default": 33554432,
"format": "int64",
"type": "integer"
},
"maxUploadBodyBytes": {
"default": 536870912,
"format": "int64",
"type": "integer"
},
"maxWsFrameBytes": {
"default": 33554432,
"format": "int64",
"type": "integer"
},
"oauthClientAllowlist": true,
"portalRecentRequestsEnabled": {
"type": "boolean"
},
"proxy": {
"default": null
},
"quotaObservationRetentionDays": {
"default": 90,
"description": "Days of upstream quota observations to keep; None keeps them all.\nCycles are never pruned. Absent in an older export, which reads as\nthe 90-day default.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"requestTimeoutMs": {
"default": 1200000,
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"retentionDays": {
"description": "Days of completed request captures to keep; None keeps them all.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"streamIdleTimeoutMs": {
"default": 300000,
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"trustedProxies": true,
"updateChannel": {
"type": [
"string",
"null"
]
},
"updateSource": {
"type": [
"string",
"null"
]
},
"updateVerifySignature": {
"type": [
"boolean",
"null"
]
},
"usageRetentionDays": {
"default": null,
"description": "Days of usage records to keep; None keeps them all. Usage statistics\nand totals are computed from these. Absent in an older export, which\nreads as keeping everything.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"instanceName",
"corsOrigins",
"trustedProxies",
"maxAttempts",
"enableSettlement",
"enableUsage",
"configRevision",
"enableTokenizerVocabs",
"enableTokenizerDownload",
"hasTokenizerAuthToken",
"enableAutoUpdateCheck",
"portalRecentRequestsEnabled"
],
"type": "object"
}Input_InstanceSettingsPatch
Complete JSON Schema
{
"additionalProperties": false,
"properties": {
"allowedHeaders": {
"default": null
},
"alwaysSecureCookie": {
"default": null,
"type": [
"boolean",
"null"
]
},
"capturePayloadMaxMb": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"capturePayloadRetentionDays": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"connectionProfileId": {
"default": null,
"type": [
"string",
"null"
]
},
"corsOrigins": {
"default": null
},
"defaultVocabularyFileId": {
"default": null,
"type": [
"string",
"null"
]
},
"enableAutoUpdateCheck": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableSettlement": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableTokenizerDownload": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableTokenizerVocabs": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableUsage": {
"default": null,
"type": [
"boolean",
"null"
]
},
"instanceName": {
"default": null,
"type": [
"string",
"null"
]
},
"maxAttempts": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"maxDatabaseSizeMb": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxMultipartParts": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"maxRequestBodyBytes": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxResponseBodyBytes": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxStreamEventBytes": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxUploadBodyBytes": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxWsFrameBytes": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"oauthClientAllowlist": {
"default": null
},
"portalRecentRequestsEnabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"proxy": {
"default": null
},
"quotaObservationRetentionDays": {
"default": null,
"description": "`null` keeps every observation.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"requestTimeoutMs": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"retentionDays": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"streamIdleTimeoutMs": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"tokenizerAuthToken": {
"default": null,
"description": "Plaintext on the way in, sealed before it reaches the row. `null`\nremoves it and downloads anonymously again.",
"type": [
"string",
"null"
]
},
"trustedProxies": {
"default": null
},
"updateChannel": {
"default": null,
"type": [
"string",
"null"
]
},
"updateSource": {
"default": null,
"type": [
"string",
"null"
]
},
"updateVerifySignature": {
"default": null,
"type": [
"boolean",
"null"
]
},
"usageRetentionDays": {
"default": null,
"description": "`null` keeps every usage record.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_InternalChatMessageMetadataPassthrough
Complete JSON Schema
Referenced structures: Input_ExecutedToolCall
{
"additionalProperties": true,
"properties": {
"cell_id": {
"type": [
"string",
"null"
]
},
"content_item_kinds": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"create_time": {
"type": [
"number",
"null"
]
},
"executed_tool_calls": {
"items": {
"$ref": "#/components/schemas/Input_ExecutedToolCall"
},
"type": [
"array",
"null"
]
},
"tool_calls_complete": {
"type": [
"boolean",
"null"
]
},
"turn_id": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_InterruptMode
Complete JSON Schema
{
"enum": [
"discard_partial_items"
],
"type": "string"
}Input_InterruptRequest
Complete JSON Schema
Referenced structures: Input_InterruptMode
{
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_InterruptMode"
},
"response_id": {
"type": "string"
}
},
"required": [
"response_id",
"mode"
],
"type": "object"
}Input_Interval
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endTime": {
"type": [
"string",
"null"
]
},
"startTime": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ItemReference
Complete JSON Schema
Referenced structures: Input_Agent, Input_ItemReferenceType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemReferenceType"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"type": "object"
}Input_ItemReferenceType
Complete JSON Schema
{
"enum": [
"item_reference"
],
"type": "string"
}Input_ItemStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete"
],
"type": "string"
}Input_JsonObjectResponseFormat
Complete JSON Schema
Referenced structures: Input_JsonObjectResponseType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_JsonObjectResponseType"
}
},
"required": [
"type"
],
"type": "object"
}Input_JsonObjectResponseType
Complete JSON Schema
{
"enum": [
"json_object"
],
"type": "string"
}Input_JsonOutputFormat
Complete JSON Schema
Referenced structures: Input_JsonOutputFormatType
{
"additionalProperties": true,
"properties": {
"schema": true,
"type": {
"$ref": "#/components/schemas/Input_JsonOutputFormatType"
}
},
"required": [
"type",
"schema"
],
"type": "object"
}Input_JsonOutputFormatType
Complete JSON Schema
{
"enum": [
"json_schema"
],
"type": "string"
}Input_JsonSchema
Complete JSON Schema
Referenced structures: Input_JsonSchemaType
{
"additionalProperties": true,
"properties": {
"$anchor": {
"type": [
"string",
"null"
]
},
"$comment": {
"type": [
"string",
"null"
]
},
"$defs": true,
"$dynamicAnchor": {
"type": [
"string",
"null"
]
},
"$dynamicRef": {
"type": [
"string",
"null"
]
},
"$id": {
"type": [
"string",
"null"
]
},
"$ref": {
"type": [
"string",
"null"
]
},
"$schema": {
"type": [
"string",
"null"
]
},
"additionalProperties": true,
"allOf": {
"items": true,
"type": [
"array",
"null"
]
},
"anyOf": {
"items": true,
"type": [
"array",
"null"
]
},
"const": true,
"default": true,
"definitions": true,
"dependencies": true,
"dependentRequired": true,
"dependentSchemas": true,
"deprecated": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"else": true,
"enum": {
"items": true,
"type": [
"array",
"null"
]
},
"examples": {
"items": true,
"type": [
"array",
"null"
]
},
"if": true,
"maxProperties": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"minProperties": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"not": true,
"oneOf": {
"items": true,
"type": [
"array",
"null"
]
},
"patternProperties": true,
"properties": true,
"propertyNames": true,
"readOnly": {
"type": [
"boolean",
"null"
]
},
"required": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"then": true,
"title": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_JsonSchemaType"
},
"unevaluatedProperties": true,
"writeOnly": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"type"
],
"type": "object"
}Input_JsonSchemaFormat
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"schema": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"strict": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_JsonSchemaResponseFormat
Complete JSON Schema
Referenced structures: Input_JsonSchemaFormat, Input_JsonSchemaResponseType
{
"additionalProperties": true,
"properties": {
"json_schema": {
"$ref": "#/components/schemas/Input_JsonSchemaFormat"
},
"type": {
"$ref": "#/components/schemas/Input_JsonSchemaResponseType"
}
},
"required": [
"type",
"json_schema"
],
"type": "object"
}Input_JsonSchemaResponseType
Complete JSON Schema
{
"enum": [
"json_schema"
],
"type": "string"
}Input_JsonSchemaType
Complete JSON Schema
{
"enum": [
"object"
],
"type": "string"
}Input_KeypressAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"keys"
],
"type": "object"
}Input_Language
Complete JSON Schema
{
"enum": [
"LANGUAGE_UNSPECIFIED",
"PYTHON"
],
"type": "string"
}Input_LanguageAuto
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_LanguageHints
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"languageCodes": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_LatLng
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"latitude": {
"format": "double",
"type": "number"
},
"longitude": {
"format": "double",
"type": "number"
}
},
"required": [
"latitude",
"longitude"
],
"type": "object"
}Input_LegacyFunction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"parameters": {
"additionalProperties": true,
"type": [
"object",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_LegacyFunctionChoice
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_LiveActivityEnd
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_LiveActivityStart
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_LiveAllowedClientEvents
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}Input_LiveAllowedServerEvents
Complete JSON Schema
Referenced structures: Input_LiveServerEventSelector
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_LiveServerEventSelector"
},
"type": "array"
}
]
}Input_LiveAudio
Complete JSON Schema
Referenced structures: Input_LiveAudioInput, Input_LiveAudioOutput
{
"additionalProperties": true,
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveAudioInput"
},
{
"type": "null"
}
]
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveAudioOutput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveAudioFormat
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"rate": {
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Input_LiveAudioInput
Complete JSON Schema
Referenced structures: Input_LiveAudioFormat
{
"additionalProperties": true,
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveAudioFormat"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveAudioOutput
Complete JSON Schema
Referenced structures: Input_LiveAudioFormat, Input_LiveVoice
{
"additionalProperties": true,
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveAudioFormat"
},
{
"type": "null"
}
]
},
"voice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveVoice"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveBlob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"data": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": [
"string",
"null"
]
},
"mimeType": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_LiveClientConfig
Complete JSON Schema
Referenced structures: Input_LiveDataChannelConfig
{
"additionalProperties": true,
"properties": {
"data_channel": {
"$ref": "#/components/schemas/Input_LiveDataChannelConfig"
}
},
"required": [
"data_channel"
],
"type": "object"
}Input_LiveClientEvent
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"session": true,
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Input_LiveClientMessage
Complete JSON Schema
Referenced structures: Input_BidiGenerateContentClientContent, Input_BidiGenerateContentRealtimeInput, Input_BidiGenerateContentSetup, Input_BidiGenerateContentToolResponse
{
"additionalProperties": true,
"properties": {
"clientContent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BidiGenerateContentClientContent"
},
{
"type": "null"
}
]
},
"realtimeInput": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BidiGenerateContentRealtimeInput"
},
{
"type": "null"
}
]
},
"setup": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BidiGenerateContentSetup"
},
{
"type": "null"
}
]
},
"toolResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BidiGenerateContentToolResponse"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveContent
Complete JSON Schema
Referenced structures: Input_LivePart
{
"additionalProperties": true,
"properties": {
"parts": {
"items": {
"$ref": "#/components/schemas/Input_LivePart"
},
"type": [
"array",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_LiveCreateTransport
Complete JSON Schema
Referenced structures: Input_LiveSipTrunk
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"sdp": {
"type": "string"
},
"type": {
"const": "webrtc",
"type": "string"
}
},
"required": [
"type",
"sdp"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"destination": {
"type": "string"
},
"trunk": {
"$ref": "#/components/schemas/Input_LiveSipTrunk"
},
"type": {
"const": "sip",
"type": "string"
}
},
"required": [
"type",
"destination",
"trunk"
],
"type": "object"
}
]
}Input_LiveDataChannelConfig
Complete JSON Schema
Referenced structures: Input_LiveAllowedClientEvents, Input_LiveAllowedServerEvents
{
"additionalProperties": true,
"properties": {
"allowed_client_events": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveAllowedClientEvents"
},
{
"type": "null"
}
]
},
"allowed_server_events": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveAllowedServerEvents"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveDecisionTrigger
Complete JSON Schema
Referenced structures: Input_LiveTriggerEvent, Input_LiveTriggerQuestions, Input_LiveTriggerType
{
"additionalProperties": true,
"properties": {
"decisions": {
"$ref": "#/components/schemas/Input_LiveTriggerQuestions"
},
"event_type": {
"$ref": "#/components/schemas/Input_LiveTriggerEvent"
},
"type": {
"$ref": "#/components/schemas/Input_LiveTriggerType"
}
},
"required": [
"type",
"event_type",
"decisions"
],
"type": "object"
}Input_LiveDecisionsConfig
Complete JSON Schema
Referenced structures: Input_DecisionQuestion
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
},
"questions": {
"items": {
"$ref": "#/components/schemas/Input_DecisionQuestion"
},
"type": "array"
}
},
"required": [
"model",
"questions"
],
"type": "object"
}Input_LiveDelegation
Complete JSON Schema
Referenced structures: Input_LiveDecisionsConfig, Input_LiveResponsesConfig
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"type": {
"const": "client",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"responses": {
"$ref": "#/components/schemas/Input_LiveResponsesConfig"
},
"type": {
"const": "responses",
"type": "string"
}
},
"required": [
"type",
"responses"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"decisions": {
"$ref": "#/components/schemas/Input_LiveDecisionsConfig"
},
"type": {
"const": "decisions",
"type": "string"
}
},
"required": [
"type",
"decisions"
],
"type": "object"
}
]
}Input_LiveDelegation2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"ack_filler": {
"type": [
"boolean",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Input_LiveGenerationConfig
Complete JSON Schema
Referenced structures: Input_AudioTranscriptionConfig, Input_GenerationMediaResolution, Input_ImageConfig, Input_LiveSpeechConfig, Input_Modality, Input_ResponseFormatConfig, Input_Schema, Input_ThinkingConfig2, Input_TranslationConfig
{
"additionalProperties": true,
"properties": {
"_responseJsonSchema": true,
"audioTranscriptionConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscriptionConfig"
},
{
"type": "null"
}
]
},
"candidateCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"enableAffectiveDialog": {
"type": [
"boolean",
"null"
]
},
"enableEnhancedCivicAnswers": {
"type": [
"boolean",
"null"
]
},
"frequencyPenalty": {
"format": "double",
"type": [
"number",
"null"
]
},
"imageConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageConfig"
},
{
"type": "null"
}
]
},
"logprobs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxOutputTokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"mediaResolution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GenerationMediaResolution"
},
{
"type": "null"
}
]
},
"presencePenalty": {
"format": "double",
"type": [
"number",
"null"
]
},
"responseFormat": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseFormatConfig"
},
{
"type": "null"
}
]
},
"responseJsonSchema": true,
"responseLogprobs": {
"type": [
"boolean",
"null"
]
},
"responseMimeType": {
"type": [
"string",
"null"
]
},
"responseModalities": {
"items": {
"$ref": "#/components/schemas/Input_Modality"
},
"type": [
"array",
"null"
]
},
"responseSchema": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Schema"
},
{
"type": "null"
}
]
},
"seed": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"speechConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveSpeechConfig"
},
{
"type": "null"
}
]
},
"stopSequences": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"temperature": {
"format": "double",
"type": [
"number",
"null"
]
},
"thinkingConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingConfig2"
},
{
"type": "null"
}
]
},
"topK": {
"type": [
"number",
"null"
]
},
"topP": {
"format": "double",
"type": [
"number",
"null"
]
},
"translationConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TranslationConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveInitialMessage
Complete JSON Schema
Referenced structures: Input_LiveInitialText
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_LiveInitialText"
},
"type": "array"
},
"role": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"role",
"content"
],
"type": "object"
}Input_LiveInitialText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_LiveInt64
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"format": "int64",
"type": "integer"
}
],
"description": "ProtoJSON int64 fields allow decimal strings and numeric JSON inputs."
}Input_LiveMultiSpeakerVoiceConfig
Complete JSON Schema
Referenced structures: Input_LiveSpeakerVoiceConfig
{
"additionalProperties": true,
"properties": {
"speakerVoiceConfigs": {
"items": {
"$ref": "#/components/schemas/Input_LiveSpeakerVoiceConfig"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_LivePart
Complete JSON Schema
Referenced structures: Input_BidiGenerateContentTranscription, Input_CodeExecutionResult2, Input_ExecutableCode, Input_FileData, Input_FunctionCall2, Input_FunctionResponse, Input_LiveBlob, Input_MediaProcessing, Input_MediaResolution, Input_SpeechMetadata, Input_ToolCall, Input_ToolResponse, Input_VideoMetadata
{
"additionalProperties": true,
"properties": {
"audioTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BidiGenerateContentTranscription"
},
{
"type": "null"
}
]
},
"codeExecutionResult": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CodeExecutionResult2"
},
{
"type": "null"
}
]
},
"executableCode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ExecutableCode"
},
{
"type": "null"
}
]
},
"fileData": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileData"
},
{
"type": "null"
}
]
},
"functionCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionCall2"
},
{
"type": "null"
}
]
},
"functionResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionResponse"
},
{
"type": "null"
}
]
},
"inlineData": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveBlob"
},
{
"type": "null"
}
]
},
"mediaProcessing": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MediaProcessing"
},
{
"type": "null"
}
]
},
"mediaResolution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MediaResolution"
},
{
"type": "null"
}
]
},
"partMetadata": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"speechMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SpeechMetadata"
},
{
"type": "null"
}
]
},
"text": {
"type": [
"string",
"null"
]
},
"thought": {
"type": [
"boolean",
"null"
]
},
"thoughtSignature": {
"type": [
"string",
"null"
]
},
"toolCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolCall"
},
{
"type": "null"
}
]
},
"toolResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolResponse"
},
{
"type": "null"
}
]
},
"videoMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_VideoMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LivePrebuiltVoiceConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"voiceName": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_LiveResponsesConfig
Complete JSON Schema
Referenced structures: Input_ReasoningConfig, Input_Tool
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"model": {
"type": "string"
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningConfig"
},
{
"type": "null"
}
]
},
"service_tier": {
"type": [
"string",
"null"
]
},
"text": true,
"tool_choice": true,
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool"
},
"type": [
"array",
"null"
]
}
},
"required": [
"model"
],
"type": "object"
}Input_LiveServerEventSelector
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"response_event": true,
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Input_LiveSessionConfig
Complete JSON Schema
Referenced structures: Input_LiveAudio, Input_LiveClientConfig, Input_LiveDecisionTrigger, Input_LiveDelegation
{
"additionalProperties": true,
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveAudio"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveClientConfig"
},
{
"type": "null"
}
]
},
"delegation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveDelegation"
},
{
"type": "null"
}
]
},
"initial_items": {
"items": true,
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": "string"
},
"triggers": {
"items": {
"$ref": "#/components/schemas/Input_LiveDecisionTrigger"
},
"type": [
"array",
"null"
]
}
},
"required": [
"model"
],
"type": "object"
}Input_LiveSessionCreateRequest
Complete JSON Schema
Referenced structures: Input_LiveDelegation2, Input_LiveInitialMessage, Input_RealtimeAudioConfig
{
"additionalProperties": true,
"description": "Frameless WebRTC setup at `POST /v1/live`. Unlike Realtime, this session\nhas no required `type: realtime`. Source: samples/codex/codex-rs/codex-api/\nsrc/endpoint/realtime_websocket/methods_frameless_bidi.rs::session_json.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioConfig"
},
{
"type": "null"
}
]
},
"delegation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveDelegation2"
},
{
"type": "null"
}
]
},
"initial_items": {
"items": {
"$ref": "#/components/schemas/Input_LiveInitialMessage"
},
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_LiveSipDigest
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"password": {
"type": "string"
},
"type": {
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"type",
"username",
"password"
],
"type": "object"
}Input_LiveSipTrunk
Complete JSON Schema
Referenced structures: Input_LiveSipDigest
{
"additionalProperties": true,
"properties": {
"auth": {
"$ref": "#/components/schemas/Input_LiveSipDigest"
},
"caller_number": {
"type": "string"
},
"provider_url": {
"type": "string"
}
},
"required": [
"provider_url",
"caller_number",
"auth"
],
"type": "object"
}Input_LiveSpeakerVoiceConfig
Complete JSON Schema
Referenced structures: Input_LiveVoiceConfig
{
"additionalProperties": true,
"properties": {
"speaker": {
"type": [
"string",
"null"
]
},
"voiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveVoiceConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveSpeechConfig
Complete JSON Schema
Referenced structures: Input_LiveMultiSpeakerVoiceConfig, Input_LiveVoiceConfig
{
"additionalProperties": true,
"properties": {
"languageCode": {
"type": [
"string",
"null"
]
},
"multiSpeakerVoiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveMultiSpeakerVoiceConfig"
},
{
"type": "null"
}
]
},
"voiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveVoiceConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_LiveTriggerEvent
Complete JSON Schema
{
"enum": [
"session.input_transcript.delta",
"session.output_transcript.delta"
],
"type": "string"
}Input_LiveTriggerQuestions
Complete JSON Schema
Referenced structures: Input_DecisionQuestion
{
"additionalProperties": true,
"properties": {
"questions": {
"items": {
"$ref": "#/components/schemas/Input_DecisionQuestion"
},
"type": "array"
}
},
"required": [
"questions"
],
"type": "object"
}Input_LiveTriggerType
Complete JSON Schema
{
"enum": [
"decisions"
],
"type": "string"
}Input_LiveVoice
Complete JSON Schema
Referenced structures: Input_CustomVoice3
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_CustomVoice3"
}
]
}Input_LiveVoiceConfig
Complete JSON Schema
Referenced structures: Input_LivePrebuiltVoiceConfig, Input_ReplicatedVoiceConfig
{
"additionalProperties": true,
"properties": {
"prebuiltVoiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LivePrebuiltVoiceConfig"
},
{
"type": "null"
}
]
},
"replicatedVoiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReplicatedVoiceConfig"
},
{
"type": "null"
}
]
},
"voice": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_LocalShellAction
Complete JSON Schema
Referenced structures: Input_LocalShellActionType
{
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_LocalShellActionType"
},
"user": {
"type": [
"string",
"null"
]
},
"working_directory": {
"type": [
"string",
"null"
]
}
},
"required": [
"command",
"env",
"type"
],
"type": "object"
}Input_LocalShellAction2
Complete JSON Schema
Referenced structures: Input_LocalShellExecAction
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_LocalShellExecAction",
"properties": {
"type": {
"const": "exec",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_LocalShellActionType
Complete JSON Schema
{
"enum": [
"exec"
],
"type": "string"
}Input_LocalShellCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_ItemStatus, Input_LocalShellAction, Input_LocalShellCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Input_LocalShellAction"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Input_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Input_LocalShellCallType"
}
},
"required": [
"type",
"id",
"call_id",
"action",
"status"
],
"type": "object"
}Input_LocalShellCallOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_ItemStatus, Input_LocalShellCallOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"output": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_LocalShellCallOutputType"
}
},
"required": [
"type",
"id",
"output"
],
"type": "object"
}Input_LocalShellCallOutputType
Complete JSON Schema
{
"enum": [
"local_shell_call_output"
],
"type": "string"
}Input_LocalShellCallType
Complete JSON Schema
{
"enum": [
"local_shell_call"
],
"type": "string"
}Input_LocalShellExecAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"timeout_ms": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"user": {
"type": [
"string",
"null"
]
},
"working_directory": {
"type": [
"string",
"null"
]
}
},
"required": [
"command",
"env",
"timeout_ms",
"user",
"working_directory"
],
"type": "object"
}Input_LocalShellStatus
Complete JSON Schema
{
"enum": [
"completed",
"in_progress",
"incomplete"
],
"type": "string"
}Input_LocalSkill
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"description",
"name",
"path"
],
"type": "object"
}Input_LocationType
Complete JSON Schema
{
"enum": [
"approximate"
],
"type": "string"
}Input_LoggingSettingsDto
Complete JSON Schema
{
"properties": {
"disableLogRedaction": {
"type": "boolean"
},
"enableDownstreamLog": {
"type": "boolean"
},
"enableDownstreamLogBody": {
"type": "boolean"
},
"enableTracing": {
"type": "boolean"
},
"enableUpstreamLog": {
"type": "boolean"
},
"enableUpstreamLogBody": {
"type": "boolean"
},
"logFormat": {
"type": "string"
},
"logLevel": {
"type": "string"
},
"queryParameterBlacklist": true,
"requestHeaderBlacklist": true,
"responseHeaderBlacklist": true
},
"required": [
"enableDownstreamLog",
"enableDownstreamLogBody",
"enableUpstreamLog",
"enableUpstreamLogBody",
"disableLogRedaction",
"enableTracing",
"logLevel",
"logFormat",
"requestHeaderBlacklist",
"responseHeaderBlacklist",
"queryParameterBlacklist"
],
"type": "object"
}Input_LoggingSettingsPatch
Complete JSON Schema
{
"properties": {
"disableLogRedaction": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableDownstreamLog": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableDownstreamLogBody": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableTracing": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableUpstreamLog": {
"default": null,
"type": [
"boolean",
"null"
]
},
"enableUpstreamLogBody": {
"default": null,
"type": [
"boolean",
"null"
]
},
"logFormat": {
"default": null,
"type": [
"string",
"null"
]
},
"logLevel": {
"default": null,
"type": [
"string",
"null"
]
},
"queryParameterBlacklist": {
"default": null
},
"requestHeaderBlacklist": {
"default": null
},
"responseHeaderBlacklist": {
"default": null
}
},
"type": "object"
}Input_LoginBody
Complete JSON Schema
{
"properties": {
"name": {
"type": "string"
},
"password": {
"type": "string"
}
},
"required": [
"name",
"password"
],
"type": "object"
}Input_MaxPrice
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"audio": {
"type": [
"string",
"null"
]
},
"completion": {
"type": [
"string",
"null"
]
},
"image": {
"type": [
"string",
"null"
]
},
"prompt": {
"type": [
"string",
"null"
]
},
"request": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_McpAllowedTools
Complete JSON Schema
Referenced structures: Input_McpToolFilter
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Input_McpToolFilter"
}
]
}Input_McpApproval
Complete JSON Schema
Referenced structures: Input_McpApprovalSetting, Input_McpToolApprovalFilter
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpApprovalSetting"
},
{
"$ref": "#/components/schemas/Input_McpToolApprovalFilter"
}
]
}Input_McpApprovalRequest
Complete JSON Schema
Referenced structures: Input_Agent, Input_McpApprovalRequestType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_McpApprovalRequestType"
}
},
"required": [
"type",
"id",
"arguments",
"name",
"server_label"
],
"type": "object"
}Input_McpApprovalRequestType
Complete JSON Schema
{
"enum": [
"mcp_approval_request"
],
"type": "string"
}Input_McpApprovalResponse
Complete JSON Schema
Referenced structures: Input_Agent, Input_McpApprovalResponseType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"approval_request_id": {
"type": "string"
},
"approve": {
"type": "boolean"
},
"id": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_McpApprovalResponseType"
}
},
"required": [
"type",
"approval_request_id",
"approve"
],
"type": "object"
}Input_McpApprovalResponseType
Complete JSON Schema
{
"enum": [
"mcp_approval_response"
],
"type": "string"
}Input_McpApprovalSetting
Complete JSON Schema
{
"enum": [
"always",
"never"
],
"type": "string"
}Input_McpCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_McpCallStatus, Input_McpCallType, Input_McpToolCallError
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"approval_request_id": {
"type": [
"string",
"null"
]
},
"arguments": {
"type": "string"
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpToolCallError"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"output": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpCallStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_McpCallType"
}
},
"required": [
"type",
"id",
"arguments",
"name",
"server_label"
],
"type": "object"
}Input_McpCallStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete",
"calling",
"failed"
],
"type": "string"
}Input_McpCallType
Complete JSON Schema
{
"enum": [
"mcp_call"
],
"type": "string"
}Input_McpListTools
Complete JSON Schema
Referenced structures: Input_Agent, Input_McpListToolsType, Input_McpToolDefinition
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"error": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"server_label": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_McpToolDefinition"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_McpListToolsType"
}
},
"required": [
"type",
"id",
"server_label",
"tools"
],
"type": "object"
}Input_McpListToolsType
Complete JSON Schema
{
"enum": [
"mcp_list_tools"
],
"type": "string"
}Input_McpListedTool
Complete JSON Schema
Referenced structures: Input_JsonSchema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"input_schema": {
"$ref": "#/components/schemas/Input_JsonSchema"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"input_schema"
],
"type": "object"
}Input_McpResultContent
Complete JSON Schema
Referenced structures: Input_TextBlock
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_TextBlock"
},
"type": "array"
}
]
}Input_McpServer
Complete JSON Schema
Referenced structures: Input_StreamableHttpTransport
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"streamableHttpTransport": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_StreamableHttpTransport"
},
{
"type": "null"
}
]
}
},
"required": [
"name"
],
"type": "object"
}Input_McpServerType
Complete JSON Schema
{
"enum": [
"url"
],
"type": "string"
}Input_McpServerUrlDefinition
Complete JSON Schema
Referenced structures: Input_McpServerType, Input_McpToolConfiguration
{
"additionalProperties": true,
"properties": {
"authorization_token": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"tool_configuration": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpToolConfiguration"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_McpServerType"
},
"url": {
"type": "string"
}
},
"required": [
"name",
"type",
"url"
],
"type": "object"
}Input_McpTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller, Input_ConnectorId, Input_McpAllowedTools, Input_McpApproval
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"allowed_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpAllowedTools"
},
{
"type": "null"
}
]
},
"authorization": {
"type": [
"string",
"null"
]
},
"connector_id": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ConnectorId"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"require_approval": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpApproval"
},
{
"type": "null"
}
]
},
"server_description": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"server_url": {
"type": [
"string",
"null"
]
},
"tunnel_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"server_label"
],
"type": "object"
}Input_McpToolApprovalFilter
Complete JSON Schema
Referenced structures: Input_McpToolFilter
{
"additionalProperties": true,
"properties": {
"always": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpToolFilter"
},
{
"type": "null"
}
]
},
"never": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpToolFilter"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_McpToolCallError
Complete JSON Schema
Referenced structures: Input_McpToolCallErrorDetails
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpToolCallErrorDetails"
},
{
"description": "Earlier Responses references represented MCP errors as strings.",
"type": "string"
}
]
}Input_McpToolCallErrorDetails
Complete JSON Schema
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"const": "mcp_protocol_error",
"type": "string"
}
},
"required": [
"type",
"code",
"message"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"content": true,
"type": {
"const": "mcp_tool_execution_error",
"type": "string"
}
},
"required": [
"type",
"content"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"const": "http_error",
"type": "string"
}
},
"required": [
"type",
"code",
"message"
],
"type": "object"
}
]
}Input_McpToolConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_McpToolConfiguration
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"allowed_tools": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_McpToolDefaultConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_McpToolDefinition
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"annotations": true,
"description": {
"type": [
"string",
"null"
]
},
"input_schema": true,
"name": {
"type": "string"
}
},
"required": [
"name",
"input_schema"
],
"type": "object"
}Input_McpToolFilter
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_McpToolListingBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_McpListedTool, Input_McpToolListingType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"mcp_server_name": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_McpListedTool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_McpToolListingType"
}
},
"required": [
"type",
"mcp_server_name",
"tools"
],
"type": "object"
}Input_McpToolListingType
Complete JSON Schema
{
"enum": [
"mcp_tool_listing"
],
"type": "string"
}Input_McpToolReference
Complete JSON Schema
Referenced structures: Input_McpToolReferenceType
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"server_name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_McpToolReferenceType"
}
},
"required": [
"name",
"server_name",
"type"
],
"type": "object"
}Input_McpToolReferenceType
Complete JSON Schema
{
"enum": [
"mcp_tool_reference"
],
"type": "string"
}Input_McpToolResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_McpResultContent, Input_McpToolResultType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpResultContent"
},
{
"type": "null"
}
]
},
"is_error": {
"type": [
"boolean",
"null"
]
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_McpToolResultType"
}
},
"required": [
"type",
"tool_use_id"
],
"type": "object"
}Input_McpToolResultType
Complete JSON Schema
{
"enum": [
"mcp_tool_result"
],
"type": "string"
}Input_McpToolUseBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_McpToolUseType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input": true,
"name": {
"type": "string"
},
"server_name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_McpToolUseType"
}
},
"required": [
"type",
"id",
"input",
"name",
"server_name"
],
"type": "object"
}Input_McpToolUseType
Complete JSON Schema
{
"enum": [
"mcp_tool_use"
],
"type": "string"
}Input_McpToolset
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_McpListedTool, Input_McpToolConfig, Input_McpToolDefaultConfig, Input_McpToolsetType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"configs": {
"additionalProperties": {
"$ref": "#/components/schemas/Input_McpToolConfig"
},
"type": [
"object",
"null"
]
},
"default_config": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_McpToolDefaultConfig"
},
{
"type": "null"
}
]
},
"mcp_server_name": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_McpListedTool"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_McpToolsetType"
}
},
"required": [
"mcp_server_name",
"type"
],
"type": "object"
}Input_McpToolsetReference
Complete JSON Schema
Referenced structures: Input_McpToolsetReferenceType
{
"additionalProperties": true,
"properties": {
"server_name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_McpToolsetReferenceType"
}
},
"required": [
"server_name",
"type"
],
"type": "object"
}Input_McpToolsetReferenceType
Complete JSON Schema
{
"enum": [
"mcp_toolset_reference"
],
"type": "string"
}Input_McpToolsetType
Complete JSON Schema
{
"enum": [
"mcp_toolset"
],
"type": "string"
}Input_MediaProcessing
Complete JSON Schema
{
"enum": [
"MEDIA_PROCESSING_UNSPECIFIED",
"STATIC",
"AGENTIC"
],
"type": "string"
}Input_MediaResolution
Complete JSON Schema
Referenced structures: Input_MediaResolutionLevel
{
"additionalProperties": true,
"properties": {
"level": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MediaResolutionLevel"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_MediaResolutionLevel
Complete JSON Schema
{
"enum": [
"MEDIA_RESOLUTION_UNSPECIFIED",
"MEDIA_RESOLUTION_LOW",
"MEDIA_RESOLUTION_MEDIUM",
"MEDIA_RESOLUTION_HIGH",
"MEDIA_RESOLUTION_ULTRA_HIGH"
],
"type": "string"
}Input_MemberPatch
Complete JSON Schema
{
"description": "The only thing a membership has to change. Moving a member to another\norganization is a remove and an add, not a patch: the pair *is* the key.",
"properties": {
"role": {
"type": "string"
}
},
"required": [
"role"
],
"type": "object"
}Input_MemberWrite
Complete JSON Schema
{
"properties": {
"role": {
"default": null,
"description": "`member` or `admin`; absent means `member`.",
"type": [
"string",
"null"
]
},
"userId": {
"type": "string"
}
},
"required": [
"userId"
],
"type": "object"
}Input_MemoryLimit
Complete JSON Schema
{
"enum": [
"1g",
"4g",
"16g",
"64g"
],
"type": "string"
}Input_MemorySummarizeRequestBody
Complete JSON Schema
Referenced structures: Input_RawMemory, Input_Reasoning
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Reasoning"
},
{
"type": "null"
}
]
},
"traces": {
"items": {
"$ref": "#/components/schemas/Input_RawMemory"
},
"type": "array"
}
},
"required": [
"model",
"traces"
],
"type": "object"
}Input_MemoryTool20250818
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_MemoryTool20250818Name, Input_MemoryTool20250818Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_MemoryTool20250818Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_MemoryTool20250818Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_MemoryTool20250818Name
Complete JSON Schema
{
"enum": [
"memory"
],
"type": "string"
}Input_MemoryTool20250818Type
Complete JSON Schema
{
"enum": [
"memory_20250818"
],
"type": "string"
}Input_Message
Complete JSON Schema
Referenced structures: Input_MessageContent2, Input_Role, Input_SystemMessageClearAt, Input_SystemMessageOutputConfig
{
"additionalProperties": true,
"properties": {
"clear_at": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SystemMessageClearAt"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_MessageContent2",
"description": "Required for user and assistant messages; system messages may omit it."
},
"output_config": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SystemMessageOutputConfig"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Input_Role"
}
},
"required": [
"role"
],
"type": "object"
}Input_MessageContent
Complete JSON Schema
Referenced structures: Input_InputContent
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_InputContent"
},
"type": "array"
}
]
}Input_MessageContent2
Complete JSON Schema
Referenced structures: Input_ContentBlock
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_ContentBlock"
},
"type": "array"
}
]
}Input_MessagePhase
Complete JSON Schema
{
"enum": [
"commentary",
"final_answer"
],
"type": "string"
}Input_MessagePhase2
Complete JSON Schema
{
"enum": [
"commentary",
"final_answer"
],
"type": "string"
}Input_MessageRole
Complete JSON Schema
{
"enum": [
"user",
"system",
"developer",
"assistant"
],
"type": "string"
}Input_MessageToolCall
Complete JSON Schema
Referenced structures: Input_ChatToolCall, Input_CustomToolCall2
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ChatToolCall"
},
{
"$ref": "#/components/schemas/Input_CustomToolCall2"
}
]
}Input_MessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Input_Metadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"user_id": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_MidConversationContent
Complete JSON Schema
Referenced structures: Input_TextBlock, Input_ToolAdditionBlock, Input_ToolRemovalBlock
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextBlock"
},
{
"$ref": "#/components/schemas/Input_ToolAdditionBlock"
},
{
"$ref": "#/components/schemas/Input_ToolRemovalBlock"
}
]
}Input_MidConversationSystemBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_MidConversationContent, Input_MidConversationSystemType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Input_MidConversationContent"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_MidConversationSystemType"
}
},
"required": [
"type",
"content"
],
"type": "object"
}Input_MidConversationSystemType
Complete JSON Schema
{
"enum": [
"mid_conv_system"
],
"type": "string"
}Input_Modality
Complete JSON Schema
{
"enum": [
"MODALITY_UNSPECIFIED",
"TEXT",
"IMAGE",
"VIDEO",
"AUDIO",
"DOCUMENT"
],
"type": "string"
}Input_Modality2
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Input_Model
Complete JSON Schema
{
"properties": {
"model": {
"type": "string"
}
},
"required": [
"model"
],
"type": "object"
}Input_ModelDto
Complete JSON Schema
Referenced structures: Input_CatalogProviderDto, Input_PriceRuleDto
{
"properties": {
"id": {
"type": "string"
},
"metadata": true,
"name": {
"type": "string"
},
"priceRules": {
"description": "Saved, enabled rules matching this model, in billing precedence order.",
"items": {
"$ref": "#/components/schemas/Input_PriceRuleDto"
},
"type": [
"array",
"null"
]
},
"providers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_CatalogProviderDto"
},
"type": "array"
},
"vocabularyFileId": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"metadata"
],
"type": "object"
}Input_ModelPatch
Complete JSON Schema
{
"properties": {
"metadata": {
"default": null
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"vocabularyFileId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ModelTest
Complete JSON Schema
{
"description": "A real generation against one provider. It spends a real credential and\nwrites a real usage row; there is no dry run.",
"properties": {
"credentialId": {
"default": null,
"description": "The credential to spend. None lets the provider's usual selection\nchoose, which is what a test of \"does this provider work\" wants.",
"type": [
"string",
"null"
]
},
"model": {
"description": "The upstream model name, as the provider's catalog spells it.",
"type": "string"
},
"providerId": {
"type": "string"
}
},
"required": [
"providerId",
"model"
],
"type": "object"
}Input_ModelWrite
Complete JSON Schema
{
"properties": {
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"metadata": {
"default": null
},
"name": {
"type": "string"
},
"vocabularyFileId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_Moderation
Complete JSON Schema
{
"enum": [
"auto",
"low"
],
"type": "string"
}Input_Moderation2
Complete JSON Schema
Referenced structures: Input_ModerationPolicy2
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
},
"policy": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ModerationPolicy2"
},
{
"type": "null"
}
]
}
},
"required": [
"model"
],
"type": "object"
}Input_ModerationContent
Complete JSON Schema
Referenced structures: Input_ModerationImageUrl
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"type",
"text"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"image_url": {
"$ref": "#/components/schemas/Input_ModerationImageUrl"
},
"type": {
"const": "image_url",
"type": "string"
}
},
"required": [
"type",
"image_url"
],
"type": "object"
}
]
}Input_ModerationImageUrl
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}Input_ModerationInput
Complete JSON Schema
Referenced structures: Input_ModerationContent
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
},
{
"items": {
"$ref": "#/components/schemas/Input_ModerationContent"
},
"type": "array"
}
]
}Input_ModerationMode
Complete JSON Schema
{
"enum": [
"score",
"block"
],
"type": "string"
}Input_ModerationMode2
Complete JSON Schema
Referenced structures: Input_ModerationModeType
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_ModerationModeType"
}
},
"required": [
"mode"
],
"type": "object"
}Input_ModerationModeType
Complete JSON Schema
{
"enum": [
"score",
"block"
],
"type": "string"
}Input_ModerationPolicy
Complete JSON Schema
Referenced structures: Input_ModerationPolicyMode
{
"additionalProperties": true,
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ModerationPolicyMode"
},
{
"type": "null"
}
]
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ModerationPolicyMode"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ModerationPolicy2
Complete JSON Schema
Referenced structures: Input_ModerationMode2
{
"additionalProperties": true,
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ModerationMode2"
},
{
"type": "null"
}
]
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ModerationMode2"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ModerationPolicyMode
Complete JSON Schema
Referenced structures: Input_ModerationMode
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_ModerationMode"
}
},
"required": [
"mode"
],
"type": "object"
}Input_MoveAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"x",
"y"
],
"type": "object"
}Input_MultiAgentCall
Complete JSON Schema
Referenced structures: Input_Action, Input_Agent, Input_MultiAgentCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Input_Action"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_MultiAgentCallType"
}
},
"required": [
"type",
"action",
"arguments",
"call_id"
],
"type": "object"
}Input_MultiAgentCallOutput
Complete JSON Schema
Referenced structures: Input_Action, Input_Agent, Input_MultiAgentCallOutputType, Input_ReplayOutputText
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Input_Action"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"items": {
"$ref": "#/components/schemas/Input_ReplayOutputText"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_MultiAgentCallOutputType"
}
},
"required": [
"type",
"action",
"call_id",
"output"
],
"type": "object"
}Input_MultiAgentCallOutputType
Complete JSON Schema
{
"enum": [
"multi_agent_call_output"
],
"type": "string"
}Input_MultiAgentCallType
Complete JSON Schema
{
"enum": [
"multi_agent_call"
],
"type": "string"
}Input_MultiAgentConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"enabled": {
"type": "boolean"
},
"max_concurrent_subagents": {
"type": [
"number",
"null"
]
}
},
"required": [
"enabled"
],
"type": "object"
}Input_MultiSpeakerVoiceConfig
Complete JSON Schema
Referenced structures: Input_SpeakerVoiceConfig
{
"additionalProperties": true,
"properties": {
"speakerVoiceConfigs": {
"items": {
"$ref": "#/components/schemas/Input_SpeakerVoiceConfig"
},
"type": "array"
}
},
"required": [
"speakerVoiceConfigs"
],
"type": "object"
}Input_MultipartImageQuality
Complete JSON Schema
{
"enum": [
"standard",
"low",
"medium",
"high",
"xhigh",
"max",
"auto"
],
"type": "string"
}Input_NamedCustom
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_NamedCustomChoice
Complete JSON Schema
Referenced structures: Input_NamedCustom, Input_NamedCustomChoiceType
{
"additionalProperties": true,
"properties": {
"custom": {
"$ref": "#/components/schemas/Input_NamedCustom"
},
"type": {
"$ref": "#/components/schemas/Input_NamedCustomChoiceType"
}
},
"required": [
"type",
"custom"
],
"type": "object"
}Input_NamedCustomChoiceType
Complete JSON Schema
{
"enum": [
"custom"
],
"type": "string"
}Input_NamedFunction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_NamedFunctionChoice
Complete JSON Schema
Referenced structures: Input_NamedFunction, Input_NamedFunctionChoiceType
{
"additionalProperties": true,
"properties": {
"function": {
"$ref": "#/components/schemas/Input_NamedFunction"
},
"type": {
"$ref": "#/components/schemas/Input_NamedFunctionChoiceType"
}
},
"required": [
"type",
"function"
],
"type": "object"
}Input_NamedFunctionChoiceType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Input_NamespaceCustomTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller, Input_CustomToolFormat
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CustomToolFormat"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_NamespaceFunctionTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"output_schema": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"parameters": true,
"strict": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_NamespaceTool
Complete JSON Schema
Referenced structures: Input_NamespaceToolDefinition
{
"additionalProperties": true,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_NamespaceToolDefinition"
},
"type": "array"
}
},
"required": [
"description",
"name",
"tools"
],
"type": "object"
}Input_NamespaceToolDefinition
Complete JSON Schema
Referenced structures: Input_NamespaceCustomTool, Input_NamespaceFunctionTool
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_NamespaceFunctionTool",
"properties": {
"type": {
"const": "function",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_NamespaceCustomTool",
"properties": {
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_NativeCreateVideoMultipartForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_NativeVideoSeconds, Input_NativeVideoSize
{
"properties": {
"input_reference": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_BinaryPart"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"prompt": {
"type": "string"
},
"seconds": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_NativeVideoSeconds"
},
{
"type": "null"
}
]
},
"size": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_NativeVideoSize"
},
{
"type": "null"
}
]
}
},
"required": [
"prompt"
],
"type": "object"
}Input_NativeCreateVideoRequestBody
Complete JSON Schema
Referenced structures: Input_NativeInputReference, Input_NativeVideoSeconds, Input_NativeVideoSize
{
"additionalProperties": true,
"properties": {
"input_reference": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_NativeInputReference"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"prompt": {
"type": "string"
},
"seconds": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_NativeVideoSeconds"
},
{
"type": "null"
}
]
},
"size": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_NativeVideoSize"
},
{
"type": "null"
}
]
}
},
"required": [
"prompt"
],
"type": "object"
}Input_NativeFileReference
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
}
},
"required": [
"file_id"
],
"type": "object"
}Input_NativeInputReference
Complete JSON Schema
Referenced structures: Input_NativeFileReference, Input_NativeUrlReference
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_NativeFileReference"
},
{
"$ref": "#/components/schemas/Input_NativeUrlReference"
}
]
}Input_NativeUrlReference
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"image_url": {
"type": "string"
}
},
"required": [
"image_url"
],
"type": "object"
}Input_NativeVideoDownloadVariant
Complete JSON Schema
{
"enum": [
"video",
"thumbnail",
"spritesheet"
],
"type": "string"
}Input_NativeVideoListOrder
Complete JSON Schema
{
"enum": [
"asc",
"desc"
],
"type": "string"
}Input_NativeVideoSeconds
Complete JSON Schema
{
"enum": [
"4",
"8",
"12"
],
"type": "string"
}Input_NativeVideoSize
Complete JSON Schema
{
"enum": [
"720x1280",
"1280x720",
"1024x1792",
"1792x1024"
],
"type": "string"
}Input_NetworkAllowlist
Complete JSON Schema
Referenced structures: Input_DomainSecret, Input_NetworkAllowlistType
{
"additionalProperties": true,
"properties": {
"allowed_domains": {
"items": {
"type": "string"
},
"type": "array"
},
"domain_secrets": {
"items": {
"$ref": "#/components/schemas/Input_DomainSecret"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_NetworkAllowlistType"
}
},
"required": [
"allowed_domains",
"type"
],
"type": "object"
}Input_NetworkAllowlistType
Complete JSON Schema
{
"enum": [
"allowlist"
],
"type": "string"
}Input_NetworkDisabled
Complete JSON Schema
Referenced structures: Input_NetworkDisabledType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_NetworkDisabledType"
}
},
"required": [
"type"
],
"type": "object"
}Input_NetworkDisabledType
Complete JSON Schema
{
"enum": [
"disabled"
],
"type": "string"
}Input_NoiseReductionType
Complete JSON Schema
{
"description": "Source: `openai/types/realtime/noise_reduction_type.py`, `NoiseReductionType`.",
"enum": [
"near_field",
"far_field"
],
"type": "string"
}Input_OAuthClientPatch
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"redirectUris": {
"default": null,
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_OAuthClientWrite
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"description": "Required, unlike every other family: the id *is* the `client_id` a\nthird-party binary was built with, so it cannot be generated here.",
"type": "string"
},
"name": {
"type": "string"
},
"redirectUris": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name"
],
"type": "object"
}Input_OpenOperation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"lineno": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"ref_id": {
"type": "string"
}
},
"required": [
"ref_id"
],
"type": "object"
}Input_OperationEndpointDto
Complete JSON Schema
{
"description": "A complete method URL for one `(operation, dialect, transport)` of one\nprovider. It replaces the URL the channel would build, not just its host.",
"properties": {
"dialect": {
"description": "A `gproxy_protocol::Dialect` id, e.g. `openai`.",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"operation": {
"type": "string"
},
"providerId": {
"type": "string"
},
"transport": {
"description": "`http` or `websocket`.",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"providerId",
"operation",
"dialect",
"transport",
"url",
"enabled"
],
"type": "object"
}Input_OperationEndpointPatch
Complete JSON Schema
{
"properties": {
"dialect": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"operation": {
"default": null,
"type": [
"string",
"null"
]
},
"transport": {
"default": null,
"type": [
"string",
"null"
]
},
"url": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_OperationEndpointWrite
Complete JSON Schema
{
"properties": {
"dialect": {
"type": "string"
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"operation": {
"type": "string"
},
"providerId": {
"type": "string"
},
"transport": {
"default": null,
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"providerId",
"operation",
"dialect",
"url"
],
"type": "object"
}Input_OperationRuleDto
Complete JSON Schema
{
"properties": {
"action": {
"type": "string"
},
"id": {
"type": "string"
},
"operation": {
"description": "A `gproxy_protocol::Operation` id, e.g. `generate_content`.",
"type": "string"
},
"providerId": {
"type": "string"
},
"target": {
"description": "Action-specific target, e.g. the destination `OperationKey`."
}
},
"required": [
"id",
"providerId",
"operation",
"action"
],
"type": "object"
}Input_OperationRulePatch
Complete JSON Schema
{
"properties": {
"action": {
"default": null,
"type": [
"string",
"null"
]
},
"operation": {
"default": null,
"type": [
"string",
"null"
]
},
"target": {
"default": null
}
},
"type": "object"
}Input_OperationRuleWrite
Complete JSON Schema
{
"properties": {
"action": {
"type": "string"
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"operation": {
"type": "string"
},
"providerId": {
"type": "string"
},
"target": {
"default": null
}
},
"required": [
"providerId",
"operation",
"action"
],
"type": "object"
}Input_OrganizationPatch
Complete JSON Schema
{
"properties": {
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"oauthClientAllowlist": {
"default": null,
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_OrganizationWrite
Complete JSON Schema
{
"properties": {
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"oauthClientAllowlist": {
"default": null,
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_Outcome
Complete JSON Schema
{
"enum": [
"OUTCOME_UNSPECIFIED",
"OUTCOME_OK",
"OUTCOME_FAILED",
"OUTCOME_DEADLINE_EXCEEDED"
],
"type": "string"
}Input_OutputAnnotation
Complete JSON Schema
Referenced structures: Input_ContainerFileCitation, Input_FileCitation, Input_FilePath, Input_UrlCitation
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileCitation"
},
{
"$ref": "#/components/schemas/Input_UrlCitation"
},
{
"$ref": "#/components/schemas/Input_ContainerFileCitation"
},
{
"$ref": "#/components/schemas/Input_FilePath"
}
]
}Input_OutputAudioBufferClearEvent
Complete JSON Schema
Referenced structures: Input_OutputAudioBufferClearEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/output_audio_buffer_clear_event.py`, `OutputAudioBufferClearEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_OutputAudioBufferClearEventType"
}
},
"required": [
"type"
],
"type": "object"
}Input_OutputAudioBufferClearEventType
Complete JSON Schema
{
"enum": [
"output_audio_buffer.clear"
],
"type": "string"
}Input_OutputConfig
Complete JSON Schema
Referenced structures: Input_Effort, Input_JsonOutputFormat, Input_TokenTaskBudget
{
"additionalProperties": true,
"properties": {
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Effort"
},
{
"type": "null"
}
]
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_JsonOutputFormat"
},
{
"type": "null"
}
]
},
"task_budget": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TokenTaskBudget"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_OutputContent
Complete JSON Schema
Referenced structures: Input_ResponseOutputRefusal, Input_ResponseOutputText
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseOutputText"
},
{
"$ref": "#/components/schemas/Input_ResponseOutputRefusal"
}
]
}Input_OutputLogprob
Complete JSON Schema
Referenced structures: Input_TopLogprob
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"logprob": {
"type": "number"
},
"token": {
"type": "string"
},
"top_logprobs": {
"items": {
"$ref": "#/components/schemas/Input_TopLogprob"
},
"type": "array"
}
},
"required": [
"token",
"bytes",
"logprob",
"top_logprobs"
],
"type": "object"
}Input_OutputMessageRole
Complete JSON Schema
{
"enum": [
"assistant"
],
"type": "string"
}Input_OutputMessageStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete"
],
"type": "string"
}Input_PageCitation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"document_index": {
"format": "int64",
"type": "integer"
},
"document_title": {
"type": "string"
},
"end_page_number": {
"format": "int64",
"type": "integer"
},
"start_page_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"cited_text",
"document_index",
"document_title",
"end_page_number",
"start_page_number"
],
"type": "object"
}Input_ParseFailed
Complete JSON Schema
{
"enum": [
"parse_failed"
],
"type": "string"
}Input_Part
Complete JSON Schema
Referenced structures: Input_AudioTranscription, Input_Blob, Input_CodeExecutionResult2, Input_ExecutableCode, Input_FileData, Input_FunctionCall2, Input_FunctionResponse, Input_MediaProcessing, Input_MediaResolution, Input_SpeechMetadata, Input_ToolCall, Input_ToolResponse, Input_VideoMetadata
{
"additionalProperties": true,
"properties": {
"audioTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscription"
},
{
"type": "null"
}
]
},
"codeExecutionResult": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CodeExecutionResult2"
},
{
"type": "null"
}
]
},
"executableCode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ExecutableCode"
},
{
"type": "null"
}
]
},
"fileData": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileData"
},
{
"type": "null"
}
]
},
"functionCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionCall2"
},
{
"type": "null"
}
]
},
"functionResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionResponse"
},
{
"type": "null"
}
]
},
"inlineData": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Blob"
},
{
"type": "null"
}
]
},
"mediaProcessing": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MediaProcessing"
},
{
"type": "null"
}
]
},
"mediaResolution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MediaResolution"
},
{
"type": "null"
}
]
},
"partMetadata": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"speechMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SpeechMetadata"
},
{
"type": "null"
}
]
},
"text": {
"type": [
"string",
"null"
]
},
"thought": {
"type": [
"boolean",
"null"
]
},
"thoughtSignature": {
"type": [
"string",
"null"
]
},
"toolCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolCall"
},
{
"type": "null"
}
]
},
"toolResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolResponse"
},
{
"type": "null"
}
]
},
"videoMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_VideoMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_PasswordBody
Complete JSON Schema
{
"properties": {
"password": {
"type": "string"
}
},
"required": [
"password"
],
"type": "object"
}Input_PdfBase64Source
Complete JSON Schema
Referenced structures: Input_PdfMediaType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"media_type": {
"$ref": "#/components/schemas/Input_PdfMediaType"
}
},
"required": [
"data",
"media_type"
],
"type": "object"
}Input_PdfMediaType
Complete JSON Schema
{
"enum": [
"application/pdf"
],
"type": "string"
}Input_PendingSafetyCheck
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
}Input_PercentileCutoffs
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"p50": {
"type": [
"number",
"null"
]
},
"p75": {
"type": [
"number",
"null"
]
},
"p90": {
"type": [
"number",
"null"
]
},
"p99": {
"type": [
"number",
"null"
]
}
},
"type": "object"
}Input_PermissionPatch
Complete JSON Schema
{
"properties": {
"action": {
"default": null,
"type": [
"string",
"null"
]
},
"apiKeyId": {
"default": null,
"type": [
"string",
"null"
]
},
"modelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"operation": {
"default": null,
"type": [
"string",
"null"
]
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"providerId": {
"default": null,
"type": [
"string",
"null"
]
},
"userId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_PermissionWrite
Complete JSON Schema
{
"properties": {
"action": {
"type": "string"
},
"apiKeyId": {
"default": null,
"type": [
"string",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"modelPattern": {
"default": null,
"description": "Absent means `*`.",
"type": [
"string",
"null"
]
},
"operation": {
"default": null,
"type": [
"string",
"null"
]
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"providerId": {
"default": null,
"type": [
"string",
"null"
]
},
"userId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"action"
],
"type": "object"
}Input_PlainTextSource
Complete JSON Schema
Referenced structures: Input_TextMediaType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"media_type": {
"$ref": "#/components/schemas/Input_TextMediaType"
}
},
"required": [
"data",
"media_type"
],
"type": "object"
}Input_Poll
Complete JSON Schema
{
"properties": {
"loginSessionId": {
"type": "string"
}
},
"required": [
"loginSessionId"
],
"type": "object"
}Input_PortalKeyCreate
Complete JSON Schema
{
"description": "What a portal user may choose when minting a key.\n\nThere is no `userId`: the key is the caller's. The two binding fields are\npresent because a user who belongs to a team wants a key scoped to it, and\nthey are validated by the same rules the admin family applies — the\norganization and the team must exist, and **the caller must be a member of\nthem**.",
"properties": {
"expiresAtMs": {
"default": null,
"description": "Absent mints a key that never expires.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"type": "string"
},
"organizationId": {
"default": null,
"type": [
"string",
"null"
]
},
"retainSecret": {
"default": null,
"description": "Keep a sealed copy so the key can be revealed later. False by default:\na key the instance cannot reproduce is a key a database leak does not\nhand over.",
"type": [
"boolean",
"null"
]
},
"teamId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_PortalPasswordChange
Complete JSON Schema
{
"description": "A portal password change.\n\n`current` is required when the account has a password and refused when it\ndoes not: an OAuth-only account has nothing to prove, and asking it for a\npassword it never set would be unanswerable.",
"properties": {
"current": {
"default": null,
"type": [
"string",
"null"
]
},
"new": {
"type": "string"
}
},
"required": [
"new"
],
"type": "object"
}Input_PrebuiltVoiceConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"voiceName": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_Prediction
Complete JSON Schema
Referenced structures: Input_PredictionType, Input_StringOrTextParts
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_StringOrTextParts"
},
"type": {
"$ref": "#/components/schemas/Input_PredictionType"
}
},
"required": [
"type",
"content"
],
"type": "object"
}Input_PredictionType
Complete JSON Schema
{
"enum": [
"content"
],
"type": "string"
}Input_PreferredCutoff
Complete JSON Schema
Referenced structures: Input_PercentileCutoffs
{
"anyOf": [
{
"type": "number"
},
{
"$ref": "#/components/schemas/Input_PercentileCutoffs"
}
]
}Input_PreviewUserLocation
Complete JSON Schema
Referenced structures: Input_UserLocationType
{
"additionalProperties": true,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"region": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_UserLocationType"
}
},
"required": [
"type"
],
"type": "object"
}Input_PriceRateDto
Complete JSON Schema
{
"description": "One billable quantity's price. `value` buys `unit_quantity` units, so a\nper-million token price is `unit_quantity = 1000000`.",
"properties": {
"conditions": {
"description": "None is the fallback rate; otherwise a nonempty object of dimensions."
},
"id": {
"type": "string"
},
"metric": {
"description": "A `gproxy_store::entity::pricing::metric` key, or a custom one.",
"type": "string"
},
"priceRuleId": {
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"unit": {
"description": "`token`, `count`, `second` or `character`.",
"type": "string"
},
"unitQuantity": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"priceRuleId",
"metric",
"unit",
"unitQuantity",
"value",
"priority"
],
"type": "object"
}Input_PriceRatePatch
Complete JSON Schema
{
"properties": {
"conditions": {
"default": null
},
"metric": {
"default": null,
"type": [
"string",
"null"
]
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"unit": {
"default": null,
"type": [
"string",
"null"
]
},
"unitQuantity": {
"default": null,
"type": [
"string",
"null"
]
},
"value": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_PriceRateWrite
Complete JSON Schema
{
"properties": {
"conditions": {
"default": null
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"metric": {
"type": "string"
},
"priceRuleId": {
"type": "string"
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"unit": {
"type": "string"
},
"unitQuantity": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"priceRuleId",
"metric",
"unit",
"unitQuantity",
"value"
],
"type": "object"
}Input_PriceRuleDto
Complete JSON Schema
{
"properties": {
"currency": {
"description": "ISO 4217, three letters.",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"modelPattern": {
"description": "A `*`/`?` glob over the upstream model name.",
"type": "string"
},
"operation": {
"description": "None covers every operation of the matched model.",
"type": [
"string",
"null"
]
},
"priority": {
"format": "int32",
"type": "integer"
},
"providerId": {
"description": "None prices every provider; a provider rule wins over a global one.",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"modelPattern",
"priority",
"currency",
"enabled"
],
"type": "object"
}Input_PriceRulePatch
Complete JSON Schema
{
"properties": {
"currency": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"modelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"operation": {
"default": null,
"type": [
"string",
"null"
]
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"providerId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_PriceRuleWrite
Complete JSON Schema
{
"properties": {
"currency": {
"type": "string"
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"modelPattern": {
"type": "string"
},
"operation": {
"default": null,
"type": [
"string",
"null"
]
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"providerId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"modelPattern",
"currency"
],
"type": "object"
}Input_PriceTierDto
Complete JSON Schema
Referenced structures: Input_CacheCreationPriceDto
{
"description": "A context or service-tier override inside one rule. Every per-million\nprice is optional: None inherits, zero is explicitly free.",
"properties": {
"audioInputPerMillion": {
"type": [
"string",
"null"
]
},
"audioOutputPerMillion": {
"type": [
"string",
"null"
]
},
"cacheCreationPerMillion": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_CacheCreationPriceDto"
},
"type": "array"
},
"cacheReadPerMillion": {
"type": [
"string",
"null"
]
},
"cachedAudioInputPerMillion": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"imageInputPerMillion": {
"type": [
"string",
"null"
]
},
"imageOutputPerMillion": {
"type": [
"string",
"null"
]
},
"inputPerMillion": {
"type": [
"string",
"null"
]
},
"minPromptTokens": {
"format": "int64",
"type": "integer"
},
"multiplier": {
"type": [
"string",
"null"
]
},
"outputPerMillion": {
"type": [
"string",
"null"
]
},
"priceRuleId": {
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"reasoningPerMillion": {
"type": [
"string",
"null"
]
},
"serviceTier": {
"description": "None is a context tier; otherwise `standard`, `priority`, `flex`, … .",
"type": [
"string",
"null"
]
},
"videoInputPerMillion": {
"type": [
"string",
"null"
]
},
"videoPerMillion": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"priceRuleId",
"minPromptTokens",
"priority"
],
"type": "object"
}Input_PriceTierPatch
Complete JSON Schema
Referenced structures: Input_CacheCreationPriceDto
{
"properties": {
"audioInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"audioOutputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"cacheCreationPerMillion": {
"default": null,
"items": {
"$ref": "#/components/schemas/Input_CacheCreationPriceDto"
},
"type": [
"array",
"null"
]
},
"cacheReadPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"cachedAudioInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"imageInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"imageOutputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"inputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"minPromptTokens": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"multiplier": {
"default": null,
"type": [
"string",
"null"
]
},
"outputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"reasoningPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"serviceTier": {
"default": null,
"type": [
"string",
"null"
]
},
"videoInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"videoPerMillion": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_PriceTierWrite
Complete JSON Schema
Referenced structures: Input_CacheCreationPriceDto
{
"properties": {
"audioInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"audioOutputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"cacheCreationPerMillion": {
"default": [],
"items": {
"$ref": "#/components/schemas/Input_CacheCreationPriceDto"
},
"type": "array"
},
"cacheReadPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"cachedAudioInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"imageInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"imageOutputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"inputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"minPromptTokens": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"multiplier": {
"default": null,
"type": [
"string",
"null"
]
},
"outputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"priceRuleId": {
"type": "string"
},
"priority": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
},
"reasoningPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"serviceTier": {
"default": null,
"type": [
"string",
"null"
]
},
"videoInputPerMillion": {
"default": null,
"type": [
"string",
"null"
]
},
"videoPerMillion": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"priceRuleId"
],
"type": "object"
}Input_ProactivityConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"proactiveAudio": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_Program
Complete JSON Schema
Referenced structures: Input_Agent, Input_ProgramType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"code": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ProgramType"
}
},
"required": [
"type",
"id",
"call_id",
"code",
"fingerprint"
],
"type": "object"
}Input_ProgramCaller
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"caller_id": {
"type": "string"
}
},
"required": [
"caller_id"
],
"type": "object"
}Input_ProgramOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_ProgramOutputStatus, Input_ProgramOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"result": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Input_ProgramOutputStatus"
},
"type": {
"$ref": "#/components/schemas/Input_ProgramOutputType"
}
},
"required": [
"type",
"id",
"call_id",
"result",
"status"
],
"type": "object"
}Input_ProgramOutputStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete"
],
"type": "string"
}Input_ProgramOutputType
Complete JSON Schema
{
"enum": [
"program_output"
],
"type": "string"
}Input_ProgramType
Complete JSON Schema
{
"enum": [
"program"
],
"type": "string"
}Input_PromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Input_PromptCacheBreakpointTtl, Input_PromptCacheMode
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_PromptCacheMode"
},
"ttl": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpointTtl"
},
{
"type": "null"
}
],
"description": "Minimum lifetime of this breakpoint; omitted inherits the request TTL.\nOpenAI OpenAPI: PromptCacheBreakpointParam (2026-10-21)."
}
},
"required": [
"mode"
],
"type": "object"
}Input_PromptCacheBreakpoint2
Complete JSON Schema
Referenced structures: Input_PromptCacheBreakpointTtl2, Input_PromptCacheMode2
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_PromptCacheMode2"
},
"ttl": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpointTtl2"
},
{
"type": "null"
}
],
"description": "Minimum lifetime of this breakpoint; omitted inherits the request TTL.\nOpenAI OpenAPI: PromptCacheBreakpointParam (2026-10-21)."
}
},
"required": [
"mode"
],
"type": "object"
}Input_PromptCacheBreakpointTtl
Complete JSON Schema
{
"description": "Explicit cache-breakpoint lifetimes from OpenAI's PromptCacheBreakpointParam.\nSeparate from the request-wide PromptCacheTTLEnum and legacy retention policy.",
"enum": [
"30m",
"12h"
],
"type": "string"
}Input_PromptCacheBreakpointTtl2
Complete JSON Schema
{
"description": "Explicit cache-breakpoint lifetimes from OpenAI's PromptCacheBreakpointParam.\nSeparate from the request-wide PromptCacheTTLEnum and legacy retention policy.",
"enum": [
"30m",
"12h"
],
"type": "string"
}Input_PromptCacheMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Input_PromptCacheMode2
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Input_PromptCacheOptionMode
Complete JSON Schema
{
"enum": [
"implicit",
"explicit"
],
"type": "string"
}Input_PromptCacheOptions
Complete JSON Schema
Referenced structures: Input_PromptCacheTtl, Input_PromptCachingMode
{
"additionalProperties": true,
"properties": {
"comparison_response_id": {
"type": [
"string",
"null"
]
},
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCachingMode"
},
{
"type": "null"
}
]
},
"prewarm": {
"type": [
"boolean",
"null"
]
},
"ttl": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheTtl"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_PromptCacheOptions2
Complete JSON Schema
Referenced structures: Input_PromptCacheOptionMode, Input_PromptCacheTtl2
{
"additionalProperties": true,
"properties": {
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheOptionMode"
},
{
"type": "null"
}
]
},
"ttl": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheTtl2"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_PromptCacheRetention
Complete JSON Schema
{
"enum": [
"in_memory",
"24h"
],
"type": "string"
}Input_PromptCacheRetention2
Complete JSON Schema
{
"enum": [
"in_memory",
"24h"
],
"type": "string"
}Input_PromptCacheTtl
Complete JSON Schema
{
"description": "Request-wide lifetimes from upstream_docs/openai/docs/Prompt caching.md.\nThe 2026-10-20 release predates the reference's request-level TTL enum update.",
"enum": [
"30m",
"12h"
],
"type": "string"
}Input_PromptCacheTtl2
Complete JSON Schema
{
"enum": [
"30m"
],
"type": "string"
}Input_PromptCachingMode
Complete JSON Schema
{
"enum": [
"implicit",
"explicit"
],
"type": "string"
}Input_PromptVariableValue
Complete JSON Schema
Referenced structures: Input_ResponseInputFile, Input_ResponseInputImage, Input_ResponseInputText
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_ResponseInputText"
},
{
"$ref": "#/components/schemas/Input_ResponseInputImage"
},
{
"$ref": "#/components/schemas/Input_ResponseInputFile"
}
],
"description": "Prompt variables are a closed union, not arbitrary JSON (source line 4419)."
}Input_PromptVoiceType
Complete JSON Schema
{
"enum": [
"prompt"
],
"type": "string"
}Input_ProviderDto
Complete JSON Schema
{
"properties": {
"baseUrl": {
"type": [
"string",
"null"
]
},
"channel": {
"description": "The channel implementation this provider speaks through; must be one\nof `Gproxy::channels()`.",
"type": "string"
},
"config": {
"description": "Channel-specific configuration; always a JSON object."
},
"connectionProfileId": {
"type": [
"string",
"null"
]
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"displayName": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"description": "Invocation URL prefix.",
"type": "string"
},
"proxy": {
"default": null
}
},
"required": [
"id",
"name",
"channel",
"config",
"enabled",
"createdAtMs"
],
"type": "object"
}Input_ProviderModelDto
Complete JSON Schema
Referenced structures: Input_PriceRuleDto
{
"properties": {
"enabled": {
"type": "boolean"
},
"hasPrice": {
"description": "A saved enabled provider or global price rule matches; populated by reads.",
"type": [
"boolean",
"null"
]
},
"id": {
"type": "string"
},
"metadata": true,
"modelId": {
"type": [
"string",
"null"
]
},
"priceRules": {
"description": "Saved, enabled rules matching this model, in billing precedence order.",
"items": {
"$ref": "#/components/schemas/Input_PriceRuleDto"
},
"type": [
"array",
"null"
]
},
"providerId": {
"type": "string"
},
"upstreamName": {
"description": "The name this provider's upstream answers to, not the public one.",
"type": "string"
}
},
"required": [
"id",
"providerId",
"upstreamName",
"metadata",
"enabled"
],
"type": "object"
}Input_ProviderModelPatch
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"metadata": {
"default": null
},
"modelId": {
"default": null,
"type": [
"string",
"null"
]
},
"providerId": {
"default": null,
"type": [
"string",
"null"
]
},
"upstreamName": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ProviderModelWrite
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"metadata": {
"default": null
},
"modelId": {
"default": null,
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
},
"upstreamName": {
"type": "string"
}
},
"required": [
"providerId",
"upstreamName"
],
"type": "object"
}Input_ProviderPartition
Complete JSON Schema
{
"enum": [
"model",
"none"
],
"type": "string"
}Input_ProviderPatch
Complete JSON Schema
{
"additionalProperties": false,
"properties": {
"baseUrl": {
"default": null,
"type": [
"string",
"null"
]
},
"config": {
"default": null
},
"connectionProfileId": {
"default": null,
"type": [
"string",
"null"
]
},
"displayName": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"proxy": {
"default": null
}
},
"type": "object"
}Input_ProviderPreferences
Complete JSON Schema
Referenced structures: Input_DataCollection, Input_MaxPrice, Input_PreferredCutoff, Input_ProviderSort, Input_Quantization
{
"additionalProperties": true,
"properties": {
"allow_fallbacks": {
"type": [
"boolean",
"null"
]
},
"data_collection": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_DataCollection"
},
{
"type": "null"
}
]
},
"enforce_distillable_text": {
"type": [
"boolean",
"null"
]
},
"ignore": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"max_price": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MaxPrice"
},
{
"type": "null"
}
]
},
"only": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"order": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"preferred_max_latency": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PreferredCutoff"
},
{
"type": "null"
}
]
},
"preferred_min_throughput": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PreferredCutoff"
},
{
"type": "null"
}
]
},
"quantizations": {
"items": {
"$ref": "#/components/schemas/Input_Quantization"
},
"type": [
"array",
"null"
]
},
"require_parameters": {
"type": [
"boolean",
"null"
]
},
"sort": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ProviderSort"
},
{
"type": "null"
}
]
},
"zdr": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_ProviderRuleSetDto
Complete JSON Schema
{
"description": "A rule set attached to a provider, in attachment order.",
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"providerId": {
"type": "string"
},
"ruleSetId": {
"type": "string"
},
"sortOrder": {
"format": "int64",
"type": "integer"
},
"updatedAtMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"providerId",
"ruleSetId",
"sortOrder",
"enabled",
"createdAtMs",
"updatedAtMs"
],
"type": "object"
}Input_ProviderRuleSetPatch
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"sortOrder": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_ProviderRuleSetWrite
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
},
"ruleSetId": {
"type": "string"
},
"sortOrder": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"providerId",
"ruleSetId"
],
"type": "object"
}Input_ProviderSort
Complete JSON Schema
Referenced structures: Input_ProviderSortBy, Input_ProviderSortConfig
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ProviderSortBy"
},
{
"$ref": "#/components/schemas/Input_ProviderSortConfig"
}
]
}Input_ProviderSortBy
Complete JSON Schema
{
"enum": [
"price",
"throughput",
"latency",
"exacto"
],
"type": "string"
}Input_ProviderSortConfig
Complete JSON Schema
Referenced structures: Input_ProviderPartition, Input_ProviderSortBy
{
"additionalProperties": true,
"properties": {
"by": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ProviderSortBy"
},
{
"type": "null"
}
]
},
"partition": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ProviderPartition"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ProviderWrite
Complete JSON Schema
{
"properties": {
"baseUrl": {
"default": null,
"type": [
"string",
"null"
]
},
"channel": {
"type": "string"
},
"config": {
"default": null
},
"connectionProfileId": {
"default": null,
"type": [
"string",
"null"
]
},
"displayName": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"description": "Supplied ids let a host import its own; blank or absent mints one.",
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"proxy": {
"default": null
}
},
"required": [
"name",
"channel"
],
"type": "object"
}Input_Quantization
Complete JSON Schema
{
"enum": [
"int4",
"int8",
"fp4",
"mxfp4",
"nvfp4",
"fp6",
"fp8",
"mxfp8",
"fp16",
"bf16",
"fp32",
"unknown"
],
"type": "string"
}Input_QuotaDto
Complete JSON Schema
{
"description": "One configured budget or operator limit. `owner_kind` is a free string:\n`user`, `api_key`, `team`, `org` and `pool` are caller budgets the host\nnames per request, while `credential` and `provider` are operator limits on\nupstream accounts. Both live in one table because both are windows over a\nmetric.",
"properties": {
"anchorAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"limitValue": {
"type": "string"
},
"metric": {
"description": "`cost` for a budget; `requests` or `cost` for a limit.",
"type": "string"
},
"modelPattern": {
"description": "A `*`/`?` glob over the upstream model name; absent covers everything.",
"type": [
"string",
"null"
]
},
"ownerId": {
"type": "string"
},
"ownerKind": {
"type": "string"
},
"period": {
"description": "`5h`, `1d`, `7d`, `1m`, `total`, or anything with `period_seconds`.",
"type": "string"
},
"periodSeconds": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"unit": {
"description": "`USD` for cost, `count` for requests.",
"type": "string"
},
"windowKey": {
"description": "Stable key within the owner, e.g. `primary`.",
"type": "string"
}
},
"required": [
"id",
"ownerKind",
"ownerId",
"windowKey",
"metric",
"unit",
"limitValue",
"period",
"enabled"
],
"type": "object"
}Input_QuotaPatch
Complete JSON Schema
{
"properties": {
"anchorAtMs": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"limitValue": {
"default": null,
"type": [
"string",
"null"
]
},
"metric": {
"default": null,
"type": [
"string",
"null"
]
},
"modelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"ownerId": {
"default": null,
"type": [
"string",
"null"
]
},
"ownerKind": {
"default": null,
"type": [
"string",
"null"
]
},
"period": {
"default": null,
"type": [
"string",
"null"
]
},
"periodSeconds": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"unit": {
"default": null,
"type": [
"string",
"null"
]
},
"windowKey": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_QuotaResetWrite
Complete JSON Schema
{
"properties": {
"grantId": {
"type": [
"string",
"null"
]
},
"program": {
"type": [
"string",
"null"
]
},
"requestId": {
"description": "Reuse after an uncertain reply to avoid consuming another grant.",
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_QuotaWrite
Complete JSON Schema
{
"properties": {
"anchorAtMs": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"limitValue": {
"type": "string"
},
"metric": {
"type": "string"
},
"modelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"ownerId": {
"type": "string"
},
"ownerKind": {
"type": "string"
},
"period": {
"type": "string"
},
"periodSeconds": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"unit": {
"type": "string"
},
"windowKey": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"ownerKind",
"ownerId",
"metric",
"unit",
"limitValue",
"period"
],
"type": "object"
}Input_Ranker
Complete JSON Schema
{
"enum": [
"auto",
"default-2024-11-15"
],
"type": "string"
}Input_RankingOptions
Complete JSON Schema
Referenced structures: Input_HybridSearch, Input_Ranker
{
"additionalProperties": true,
"properties": {
"hybrid_search": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_HybridSearch"
},
{
"type": "null"
}
]
},
"ranker": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Ranker"
},
{
"type": "null"
}
]
},
"score_threshold": {
"type": [
"number",
"null"
]
}
},
"type": "object"
}Input_RateLimitPatch
Complete JSON Schema
{
"properties": {
"apiKeyId": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"limitValue": {
"default": null,
"type": [
"string",
"null"
]
},
"metric": {
"default": null,
"type": [
"string",
"null"
]
},
"modelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"periodSeconds": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"userId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RateLimitWrite
Complete JSON Schema
{
"properties": {
"apiKeyId": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"limitValue": {
"type": "string"
},
"metric": {
"type": "string"
},
"modelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"periodSeconds": {
"format": "int64",
"type": "integer"
},
"userId": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"metric",
"limitValue",
"periodSeconds"
],
"type": "object"
}Input_RawMemory
Complete JSON Schema
Referenced structures: Input_RawMemoryMetadata
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"items": {
"items": true,
"type": "array"
},
"metadata": {
"$ref": "#/components/schemas/Input_RawMemoryMetadata"
}
},
"required": [
"id",
"metadata",
"items"
],
"type": "object"
}Input_RawMemoryMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"source_path": {
"type": "string"
}
},
"required": [
"source_path"
],
"type": "object"
}Input_RealtimeAudioConfig
Complete JSON Schema
Referenced structures: Input_RealtimeAudioConfigInput, Input_RealtimeAudioConfigOutput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config.py`, `RealtimeAudioConfig`.",
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioConfigInput"
},
{
"type": "null"
}
]
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioConfigOutput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeAudioConfigInput
Complete JSON Schema
Referenced structures: Input_AudioTranscription2, Input_RealtimeAudioConfigInputNoiseReduction, Input_RealtimeAudioFormats, Input_RealtimeAudioInputTurnDetection
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_input.py`, `RealtimeAudioConfigInput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"noise_reduction": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioConfigInputNoiseReduction"
},
{
"type": "null"
}
]
},
"transcription": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscription2"
},
{
"type": "null"
}
]
},
"turn_detection": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioInputTurnDetection"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeAudioConfigInputNoiseReduction
Complete JSON Schema
Referenced structures: Input_NoiseReductionType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_input.py`, `NoiseReduction`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_NoiseReductionType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeAudioConfigOutput
Complete JSON Schema
Referenced structures: Input_RealtimeAudioConfigOutputVoice, Input_RealtimeAudioFormats
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_output.py`, `RealtimeAudioConfigOutput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"speed": {
"type": [
"number",
"null"
]
},
"voice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioConfigOutputVoice"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeAudioConfigOutputVoice
Complete JSON Schema
Referenced structures: Input_RealtimeAudioConfigOutputVoiceID
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_RealtimeAudioConfigOutputVoiceID"
}
],
"description": "Source: `openai/types/realtime/realtime_audio_config_output.py`, `Voice`."
}Input_RealtimeAudioConfigOutputVoiceID
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_output.py`, `VoiceID`.",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Input_RealtimeAudioFormats
Complete JSON Schema
Referenced structures: Input_RealtimeAudioFormatsAudioPCM, Input_RealtimeAudioFormatsAudioPCMA, Input_RealtimeAudioFormatsAudioPCMU
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormatsAudioPCM"
},
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormatsAudioPCMU"
},
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormatsAudioPCMA"
}
],
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `RealtimeAudioFormats`."
}Input_RealtimeAudioFormatsAudioPCM
Complete JSON Schema
Referenced structures: Input_RealtimeAudioFormatsAudioPCMRate, Input_RealtimeAudioFormatsAudioPCMType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `AudioPCM`.",
"properties": {
"rate": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormatsAudioPCMRate"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormatsAudioPCMType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeAudioFormatsAudioPCMA
Complete JSON Schema
Referenced structures: Input_RealtimeAudioFormatsAudioPCMAType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `AudioPCMA`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormatsAudioPCMAType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeAudioFormatsAudioPCMAType
Complete JSON Schema
{
"enum": [
"audio/pcma"
],
"type": "string"
}Input_RealtimeAudioFormatsAudioPCMRate
Complete JSON Schema
{
"description": "A numeric literal validated through scalar conversion; object routing remains derived.",
"format": "int64",
"type": "integer"
}Input_RealtimeAudioFormatsAudioPCMType
Complete JSON Schema
{
"enum": [
"audio/pcm"
],
"type": "string"
}Input_RealtimeAudioFormatsAudioPCMU
Complete JSON Schema
Referenced structures: Input_RealtimeAudioFormatsAudioPCMUType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `AudioPCMU`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormatsAudioPCMUType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeAudioFormatsAudioPCMUType
Complete JSON Schema
{
"enum": [
"audio/pcmu"
],
"type": "string"
}Input_RealtimeAudioInputTurnDetection
Complete JSON Schema
Referenced structures: Input_RealtimeAudioInputTurnDetectionSemanticVad, Input_RealtimeAudioInputTurnDetectionServerVad
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioInputTurnDetectionServerVad"
},
{
"$ref": "#/components/schemas/Input_RealtimeAudioInputTurnDetectionSemanticVad"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_audio_input_turn_detection.py`, `RealtimeAudioInputTurnDetection`."
}Input_RealtimeAudioInputTurnDetectionSemanticVad
Complete JSON Schema
Referenced structures: Input_RealtimeAudioInputTurnDetectionSemanticVadEagerness, Input_RealtimeAudioInputTurnDetectionSemanticVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_input_turn_detection.py`, `SemanticVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"eagerness": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioInputTurnDetectionSemanticVadEagerness"
},
{
"type": "null"
}
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeAudioInputTurnDetectionSemanticVadType"
}
},
"required": [
"type"
],
"type": "object"
}Input_RealtimeAudioInputTurnDetectionSemanticVadEagerness
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"auto"
],
"type": "string"
}Input_RealtimeAudioInputTurnDetectionSemanticVadType
Complete JSON Schema
{
"enum": [
"semantic_vad"
],
"type": "string"
}Input_RealtimeAudioInputTurnDetectionServerVad
Complete JSON Schema
Referenced structures: Input_RealtimeAudioInputTurnDetectionServerVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_input_turn_detection.py`, `ServerVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"idle_timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"prefix_padding_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silence_duration_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeAudioInputTurnDetectionServerVadType"
}
},
"required": [
"type"
],
"type": "object"
}Input_RealtimeAudioInputTurnDetectionServerVadType
Complete JSON Schema
{
"enum": [
"server_vad"
],
"type": "string"
}Input_RealtimeClientEvent
Complete JSON Schema
Referenced structures: Input_ConversationItemCreateEvent, Input_ConversationItemDeleteEvent, Input_ConversationItemRetrieveEvent, Input_ConversationItemTruncateEvent, Input_InputAudioBufferAppendEvent, Input_InputAudioBufferClearEvent, Input_InputAudioBufferCommitEvent, Input_OutputAudioBufferClearEvent, Input_ResponseCancelEvent, Input_ResponseCreateEvent, Input_SessionUpdateEvent
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ConversationItemCreateEvent"
},
{
"$ref": "#/components/schemas/Input_ConversationItemDeleteEvent"
},
{
"$ref": "#/components/schemas/Input_ConversationItemRetrieveEvent"
},
{
"$ref": "#/components/schemas/Input_ConversationItemTruncateEvent"
},
{
"$ref": "#/components/schemas/Input_InputAudioBufferAppendEvent"
},
{
"$ref": "#/components/schemas/Input_InputAudioBufferClearEvent"
},
{
"$ref": "#/components/schemas/Input_OutputAudioBufferClearEvent"
},
{
"$ref": "#/components/schemas/Input_InputAudioBufferCommitEvent"
},
{
"$ref": "#/components/schemas/Input_ResponseCancelEvent"
},
{
"$ref": "#/components/schemas/Input_ResponseCreateEvent"
},
{
"$ref": "#/components/schemas/Input_SessionUpdateEvent"
}
],
"description": "Source: `openai/types/realtime/realtime_client_event.py`, `RealtimeClientEvent`."
}Input_RealtimeConversationItemAssistantMessage
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemAssistantMessageContent, Input_RealtimeConversationItemAssistantMessageObject, Input_RealtimeConversationItemAssistantMessageRole, Input_RealtimeConversationItemAssistantMessageStatus, Input_RealtimeConversationItemAssistantMessageType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_assistant_message.py`, `RealtimeConversationItemAssistantMessage`.",
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemAssistantMessageContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemAssistantMessageObject"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemAssistantMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemAssistantMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemAssistantMessageType"
}
},
"required": [
"content",
"role",
"type"
],
"type": "object"
}Input_RealtimeConversationItemAssistantMessageContent
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemAssistantMessageContentType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_assistant_message.py`, `Content`.",
"properties": {
"audio": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemAssistantMessageContentType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeConversationItemAssistantMessageContentType
Complete JSON Schema
{
"enum": [
"output_text",
"output_audio"
],
"type": "string"
}Input_RealtimeConversationItemAssistantMessageObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Input_RealtimeConversationItemAssistantMessageRole
Complete JSON Schema
{
"enum": [
"assistant"
],
"type": "string"
}Input_RealtimeConversationItemAssistantMessageStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Input_RealtimeConversationItemAssistantMessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Input_RealtimeConversationItemFunctionCall
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemFunctionCallObject, Input_RealtimeConversationItemFunctionCallStatus, Input_RealtimeConversationItemFunctionCallType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_function_call.py`, `RealtimeConversationItemFunctionCall`.",
"properties": {
"arguments": {
"type": "string"
},
"call_id": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCallObject"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCallStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCallType"
}
},
"required": [
"arguments",
"name",
"type"
],
"type": "object"
}Input_RealtimeConversationItemFunctionCallObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Input_RealtimeConversationItemFunctionCallOutput
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemFunctionCallOutputObject, Input_RealtimeConversationItemFunctionCallOutputStatus, Input_RealtimeConversationItemFunctionCallOutputType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_function_call_output.py`, `RealtimeConversationItemFunctionCallOutput`.",
"properties": {
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCallOutputObject"
},
{
"type": "null"
}
]
},
"output": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCallOutputStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemFunctionCallOutputType"
}
},
"required": [
"call_id",
"output",
"type"
],
"type": "object"
}Input_RealtimeConversationItemFunctionCallOutputObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Input_RealtimeConversationItemFunctionCallOutputStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Input_RealtimeConversationItemFunctionCallOutputType
Complete JSON Schema
{
"enum": [
"function_call_output"
],
"type": "string"
}Input_RealtimeConversationItemFunctionCallStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Input_RealtimeConversationItemFunctionCallType
Complete JSON Schema
{
"enum": [
"function_call"
],
"type": "string"
}Input_RealtimeConversationItemSystemMessage
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemSystemMessageContent, Input_RealtimeConversationItemSystemMessageObject, Input_RealtimeConversationItemSystemMessageRole, Input_RealtimeConversationItemSystemMessageStatus, Input_RealtimeConversationItemSystemMessageType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_system_message.py`, `RealtimeConversationItemSystemMessage`.",
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemSystemMessageContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemSystemMessageObject"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemSystemMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemSystemMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemSystemMessageType"
}
},
"required": [
"content",
"role",
"type"
],
"type": "object"
}Input_RealtimeConversationItemSystemMessageContent
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemSystemMessageContentType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_system_message.py`, `Content`.",
"properties": {
"text": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemSystemMessageContentType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeConversationItemSystemMessageContentType
Complete JSON Schema
{
"enum": [
"input_text"
],
"type": "string"
}Input_RealtimeConversationItemSystemMessageObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Input_RealtimeConversationItemSystemMessageRole
Complete JSON Schema
{
"enum": [
"system"
],
"type": "string"
}Input_RealtimeConversationItemSystemMessageStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Input_RealtimeConversationItemSystemMessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Input_RealtimeConversationItemUserMessage
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemUserMessageContent, Input_RealtimeConversationItemUserMessageObject, Input_RealtimeConversationItemUserMessageRole, Input_RealtimeConversationItemUserMessageStatus, Input_RealtimeConversationItemUserMessageType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_user_message.py`, `RealtimeConversationItemUserMessage`.",
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessageContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessageObject"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessageType"
}
},
"required": [
"content",
"role",
"type"
],
"type": "object"
}Input_RealtimeConversationItemUserMessageContent
Complete JSON Schema
Referenced structures: Input_RealtimeConversationItemUserMessageContentDetail, Input_RealtimeConversationItemUserMessageContentType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_user_message.py`, `Content`.",
"properties": {
"audio": {
"type": [
"string",
"null"
]
},
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessageContentDetail"
},
{
"type": "null"
}
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeConversationItemUserMessageContentType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeConversationItemUserMessageContentDetail
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high"
],
"type": "string"
}Input_RealtimeConversationItemUserMessageContentType
Complete JSON Schema
{
"enum": [
"input_text",
"input_audio",
"input_image"
],
"type": "string"
}Input_RealtimeConversationItemUserMessageObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Input_RealtimeConversationItemUserMessageRole
Complete JSON Schema
{
"enum": [
"user"
],
"type": "string"
}Input_RealtimeConversationItemUserMessageStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Input_RealtimeConversationItemUserMessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Input_RealtimeFunctionTool
Complete JSON Schema
Referenced structures: Input_RealtimeFunctionToolType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_function_tool.py`, `RealtimeFunctionTool`.",
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"parameters": true,
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeFunctionToolType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeFunctionToolType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Input_RealtimeInputConfig
Complete JSON Schema
Referenced structures: Input_ActivityHandling, Input_AutomaticActivityDetection, Input_TurnCoverage
{
"additionalProperties": true,
"properties": {
"activityHandling": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ActivityHandling"
},
{
"type": "null"
}
]
},
"automaticActivityDetection": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AutomaticActivityDetection"
},
{
"type": "null"
}
]
},
"interimTranscriptTimestampEnabled": {
"type": [
"boolean",
"null"
]
},
"turnCoverage": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TurnCoverage"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeMcpApprovalRequest
Complete JSON Schema
Referenced structures: Input_RealtimeMcpApprovalRequestType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_approval_request.py`, `RealtimeMcpApprovalRequest`.",
"properties": {
"arguments": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeMcpApprovalRequestType"
}
},
"required": [
"id",
"arguments",
"name",
"server_label",
"type"
],
"type": "object"
}Input_RealtimeMcpApprovalRequestType
Complete JSON Schema
{
"enum": [
"mcp_approval_request"
],
"type": "string"
}Input_RealtimeMcpApprovalResponse
Complete JSON Schema
Referenced structures: Input_RealtimeMcpApprovalResponseType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_approval_response.py`, `RealtimeMcpApprovalResponse`.",
"properties": {
"approval_request_id": {
"type": "string"
},
"approve": {
"type": "boolean"
},
"id": {
"type": "string"
},
"reason": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeMcpApprovalResponseType"
}
},
"required": [
"id",
"approval_request_id",
"approve",
"type"
],
"type": "object"
}Input_RealtimeMcpApprovalResponseType
Complete JSON Schema
{
"enum": [
"mcp_approval_response"
],
"type": "string"
}Input_RealtimeMcpListTools
Complete JSON Schema
Referenced structures: Input_RealtimeMcpListToolsTool, Input_RealtimeMcpListToolsType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_list_tools.py`, `RealtimeMcpListTools`.",
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeMcpListToolsTool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeMcpListToolsType"
}
},
"required": [
"server_label",
"tools",
"type"
],
"type": "object"
}Input_RealtimeMcpListToolsTool
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_list_tools.py`, `Tool`.",
"properties": {
"annotations": true,
"description": {
"type": [
"string",
"null"
]
},
"input_schema": true,
"name": {
"type": "string"
}
},
"required": [
"input_schema",
"name"
],
"type": "object"
}Input_RealtimeMcpListToolsType
Complete JSON Schema
{
"enum": [
"mcp_list_tools"
],
"type": "string"
}Input_RealtimeMcpProtocolError
Complete JSON Schema
Referenced structures: Input_RealtimeMcpProtocolErrorType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_protocol_error.py`, `RealtimeMcpProtocolError`.",
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeMcpProtocolErrorType"
}
},
"required": [
"code",
"message",
"type"
],
"type": "object"
}Input_RealtimeMcpProtocolErrorType
Complete JSON Schema
{
"enum": [
"protocol_error"
],
"type": "string"
}Input_RealtimeMcpToolCall
Complete JSON Schema
Referenced structures: Input_RealtimeMcpToolCallError, Input_RealtimeMcpToolCallType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_tool_call.py`, `RealtimeMcpToolCall`.",
"properties": {
"approval_request_id": {
"type": [
"string",
"null"
]
},
"arguments": {
"type": "string"
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeMcpToolCallError"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"output": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeMcpToolCallType"
}
},
"required": [
"id",
"arguments",
"name",
"server_label",
"type"
],
"type": "object"
}Input_RealtimeMcpToolCallError
Complete JSON Schema
Referenced structures: Input_RealtimeMcpProtocolError, Input_RealtimeMcpToolExecutionError, Input_RealtimeMcphttpError
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeMcpProtocolError"
},
{
"$ref": "#/components/schemas/Input_RealtimeMcpToolExecutionError"
},
{
"$ref": "#/components/schemas/Input_RealtimeMcphttpError"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_mcp_tool_call.py`, `Error`."
}Input_RealtimeMcpToolCallType
Complete JSON Schema
{
"enum": [
"mcp_call"
],
"type": "string"
}Input_RealtimeMcpToolExecutionError
Complete JSON Schema
Referenced structures: Input_RealtimeMcpToolExecutionErrorType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_tool_execution_error.py`, `RealtimeMcpToolExecutionError`.",
"properties": {
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeMcpToolExecutionErrorType"
}
},
"required": [
"message",
"type"
],
"type": "object"
}Input_RealtimeMcpToolExecutionErrorType
Complete JSON Schema
{
"enum": [
"tool_execution_error"
],
"type": "string"
}Input_RealtimeMcphttpError
Complete JSON Schema
Referenced structures: Input_RealtimeMcphttpErrorType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcphttp_error.py`, `RealtimeMcphttpError`.",
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeMcphttpErrorType"
}
},
"required": [
"code",
"message",
"type"
],
"type": "object"
}Input_RealtimeMcphttpErrorType
Complete JSON Schema
{
"enum": [
"http_error"
],
"type": "string"
}Input_RealtimeReasoning
Complete JSON Schema
Referenced structures: Input_RealtimeReasoningEffort
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_reasoning.py`, `RealtimeReasoning`.",
"properties": {
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeReasoningEffort"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeReasoningEffort
Complete JSON Schema
{
"description": "Source: `openai/types/realtime/realtime_reasoning_effort.py`, `RealtimeReasoningEffort`.",
"enum": [
"minimal",
"low",
"medium",
"high",
"xhigh"
],
"type": "string"
}Input_RealtimeResponseCreateAudioOutput
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateAudioOutputOutput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_audio_output.py`, `RealtimeResponseCreateAudioOutput`.",
"properties": {
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateAudioOutputOutput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeResponseCreateAudioOutputOutput
Complete JSON Schema
Referenced structures: Input_RealtimeAudioFormats, Input_RealtimeResponseCreateAudioOutputOutputVoice
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_audio_output.py`, `Output`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"voice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateAudioOutputOutputVoice"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeResponseCreateAudioOutputOutputVoice
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateAudioOutputOutputVoiceID
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateAudioOutputOutputVoiceID"
}
],
"description": "Source: `openai/types/realtime/realtime_response_create_audio_output.py`, `OutputVoice`."
}Input_RealtimeResponseCreateAudioOutputOutputVoiceID
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_audio_output.py`, `OutputVoiceID`.",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Input_RealtimeResponseCreateMcpTool
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateMcpToolAllowedCallersItem, Input_RealtimeResponseCreateMcpToolAllowedTools, Input_RealtimeResponseCreateMcpToolConnectorId, Input_RealtimeResponseCreateMcpToolRequireApproval, Input_RealtimeResponseCreateMcpToolType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_mcp_tool.py`, `RealtimeResponseCreateMcpTool`.",
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolAllowedCallersItem"
},
"type": [
"array",
"null"
]
},
"allowed_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolAllowedTools"
},
{
"type": "null"
}
]
},
"authorization": {
"type": [
"string",
"null"
]
},
"connector_id": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolConnectorId"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"require_approval": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolRequireApproval"
},
{
"type": "null"
}
]
},
"server_description": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"server_url": {
"type": [
"string",
"null"
]
},
"tunnel_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolType"
}
},
"required": [
"server_label",
"type"
],
"type": "object"
}Input_RealtimeResponseCreateMcpToolAllowedCallersItem
Complete JSON Schema
{
"enum": [
"direct",
"programmatic"
],
"type": "string"
}Input_RealtimeResponseCreateMcpToolAllowedTools
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateMcpToolAllowedToolsMcpToolFilter
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolAllowedToolsMcpToolFilter"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_response_create_mcp_tool.py`, `AllowedTools`."
}Input_RealtimeResponseCreateMcpToolAllowedToolsMcpToolFilter
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_mcp_tool.py`, `AllowedToolsMcpToolFilter`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_RealtimeResponseCreateMcpToolConnectorId
Complete JSON Schema
{
"enum": [
"connector_dropbox",
"connector_gmail",
"connector_googlecalendar",
"connector_googledrive",
"connector_microsoftteams",
"connector_outlookcalendar",
"connector_outlookemail",
"connector_sharepoint"
],
"type": "string"
}Input_RealtimeResponseCreateMcpToolRequireApproval
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilter, Input_RealtimeResponseCreateMcpToolRequireApprovalVariant2
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilter"
},
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolRequireApprovalVariant2"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_response_create_mcp_tool.py`, `RequireApproval`."
}Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilter
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilterAlways, Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilterNever
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_mcp_tool.py`, `RequireApprovalMcpToolApprovalFilter`.",
"properties": {
"always": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilterAlways"
},
{
"type": "null"
}
]
},
"never": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilterNever"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilterAlways
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_mcp_tool.py`, `RequireApprovalMcpToolApprovalFilterAlways`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_RealtimeResponseCreateMcpToolRequireApprovalMcpToolApprovalFilterNever
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_mcp_tool.py`, `RequireApprovalMcpToolApprovalFilterNever`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_RealtimeResponseCreateMcpToolRequireApprovalVariant2
Complete JSON Schema
{
"enum": [
"always",
"never"
],
"type": "string"
}Input_RealtimeResponseCreateMcpToolType
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Input_RealtimeResponseCreateParams
Complete JSON Schema
Referenced structures: Input_ConversationItem, Input_RealtimeReasoning, Input_RealtimeResponseCreateAudioOutput, Input_RealtimeResponseCreateParamsMaxOutputTokens, Input_RealtimeResponseCreateParamsOutputModalitiesItem, Input_RealtimeResponseCreateParamsTool, Input_RealtimeResponseCreateParamsToolChoice, Input_ResponsePrompt2
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_create_params.py`, `RealtimeResponseCreateParams`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateAudioOutput"
},
{
"type": "null"
}
]
},
"conversation": {
"type": [
"string",
"null"
]
},
"input": {
"items": {
"$ref": "#/components/schemas/Input_ConversationItem"
},
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateParamsMaxOutputTokens"
},
{
"type": "null"
}
]
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"output_modalities": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeResponseCreateParamsOutputModalitiesItem"
},
"type": [
"array",
"null"
]
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponsePrompt2"
},
{
"type": "null"
}
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeReasoning"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateParamsToolChoice"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeResponseCreateParamsTool"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_RealtimeResponseCreateParamsMaxOutputTokens
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateParamsMaxOutputTokensVariant2
{
"anyOf": [
{
"format": "int64",
"type": "integer"
},
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateParamsMaxOutputTokensVariant2"
}
]
}Input_RealtimeResponseCreateParamsMaxOutputTokensVariant2
Complete JSON Schema
{
"enum": [
"inf"
],
"type": "string"
}Input_RealtimeResponseCreateParamsOutputModalitiesItem
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Input_RealtimeResponseCreateParamsTool
Complete JSON Schema
Referenced structures: Input_RealtimeFunctionTool, Input_RealtimeResponseCreateMcpTool
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeFunctionTool"
},
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateMcpTool"
}
],
"description": "Source: `openai/types/realtime/realtime_response_create_params.py`, `Tool`."
}Input_RealtimeResponseCreateParamsToolChoice
Complete JSON Schema
Referenced structures: Input_ToolChoiceFunction2, Input_ToolChoiceMcp2, Input_ToolChoiceOptions
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoiceOptions"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceFunction2"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceMcp2"
}
],
"description": "Source: `openai/types/realtime/realtime_response_create_params.py`, `ToolChoice`."
}Input_RealtimeSessionCreateRequest
Complete JSON Schema
Referenced structures: Input_RealtimeAudioConfig, Input_RealtimeReasoning, Input_RealtimeSessionCreateRequestIncludeItem, Input_RealtimeSessionCreateRequestMaxOutputTokens, Input_RealtimeSessionCreateRequestOutputModalitiesItem, Input_RealtimeSessionCreateRequestType, Input_RealtimeToolChoiceConfig, Input_RealtimeToolsConfigUnion, Input_RealtimeTracingConfig, Input_RealtimeTruncation, Input_ResponsePrompt2
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_request.py`, `RealtimeSessionCreateRequest`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioConfig"
},
{
"type": "null"
}
]
},
"include": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequestIncludeItem"
},
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequestMaxOutputTokens"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"output_modalities": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequestOutputModalitiesItem"
},
"type": [
"array",
"null"
]
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponsePrompt2"
},
{
"type": "null"
}
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeReasoning"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeToolChoiceConfig"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnion"
},
"type": [
"array",
"null"
]
},
"tracing": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTracingConfig"
},
{
"type": "null"
}
]
},
"truncation": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTruncation"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequestType"
}
},
"required": [
"type"
],
"type": "object"
}Input_RealtimeSessionCreateRequestIncludeItem
Complete JSON Schema
{
"enum": [
"item.input_audio_transcription.logprobs"
],
"type": "string"
}Input_RealtimeSessionCreateRequestMaxOutputTokens
Complete JSON Schema
Referenced structures: Input_RealtimeSessionCreateRequestMaxOutputTokensVariant2
{
"anyOf": [
{
"format": "int64",
"type": "integer"
},
{
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequestMaxOutputTokensVariant2"
}
]
}Input_RealtimeSessionCreateRequestMaxOutputTokensVariant2
Complete JSON Schema
{
"enum": [
"inf"
],
"type": "string"
}Input_RealtimeSessionCreateRequestOutputModalitiesItem
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Input_RealtimeSessionCreateRequestType
Complete JSON Schema
{
"enum": [
"realtime"
],
"type": "string"
}Input_RealtimeToolChoiceConfig
Complete JSON Schema
Referenced structures: Input_ToolChoiceFunction2, Input_ToolChoiceMcp2, Input_ToolChoiceOptions
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoiceOptions"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceFunction2"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceMcp2"
}
],
"description": "Source: `openai/types/realtime/realtime_tool_choice_config.py`, `RealtimeToolChoiceConfig`."
}Input_RealtimeToolsConfigUnion
Complete JSON Schema
Referenced structures: Input_RealtimeFunctionTool, Input_RealtimeToolsConfigUnionMcp
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeFunctionTool"
},
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcp"
}
],
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `RealtimeToolsConfigUnion`."
}Input_RealtimeToolsConfigUnionMcp
Complete JSON Schema
Referenced structures: Input_RealtimeToolsConfigUnionMcpAllowedCallersItem, Input_RealtimeToolsConfigUnionMcpAllowedTools, Input_RealtimeToolsConfigUnionMcpConnectorId, Input_RealtimeToolsConfigUnionMcpRequireApproval, Input_RealtimeToolsConfigUnionMcpType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `Mcp`.",
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpAllowedCallersItem"
},
"type": [
"array",
"null"
]
},
"allowed_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpAllowedTools"
},
{
"type": "null"
}
]
},
"authorization": {
"type": [
"string",
"null"
]
},
"connector_id": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpConnectorId"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"require_approval": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpRequireApproval"
},
{
"type": "null"
}
]
},
"server_description": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"server_url": {
"type": [
"string",
"null"
]
},
"tunnel_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpType"
}
},
"required": [
"server_label",
"type"
],
"type": "object"
}Input_RealtimeToolsConfigUnionMcpAllowedCallersItem
Complete JSON Schema
{
"enum": [
"direct",
"programmatic"
],
"type": "string"
}Input_RealtimeToolsConfigUnionMcpAllowedTools
Complete JSON Schema
Referenced structures: Input_RealtimeToolsConfigUnionMcpAllowedToolsMcpToolFilter
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpAllowedToolsMcpToolFilter"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpAllowedTools`."
}Input_RealtimeToolsConfigUnionMcpAllowedToolsMcpToolFilter
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpAllowedToolsMcpToolFilter`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_RealtimeToolsConfigUnionMcpConnectorId
Complete JSON Schema
{
"enum": [
"connector_dropbox",
"connector_gmail",
"connector_googlecalendar",
"connector_googledrive",
"connector_microsoftteams",
"connector_outlookcalendar",
"connector_outlookemail",
"connector_sharepoint"
],
"type": "string"
}Input_RealtimeToolsConfigUnionMcpRequireApproval
Complete JSON Schema
Referenced structures: Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilter, Input_RealtimeToolsConfigUnionMcpRequireApprovalVariant2
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilter"
},
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpRequireApprovalVariant2"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApproval`."
}Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilter
Complete JSON Schema
Referenced structures: Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterAlways, Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterNever
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApprovalMcpToolApprovalFilter`.",
"properties": {
"always": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterAlways"
},
{
"type": "null"
}
]
},
"never": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterNever"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterAlways
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApprovalMcpToolApprovalFilterAlways`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterNever
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApprovalMcpToolApprovalFilterNever`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_RealtimeToolsConfigUnionMcpRequireApprovalVariant2
Complete JSON Schema
{
"enum": [
"always",
"never"
],
"type": "string"
}Input_RealtimeToolsConfigUnionMcpType
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Input_RealtimeTracingConfig
Complete JSON Schema
Referenced structures: Input_RealtimeTracingConfigTracingConfiguration, Input_RealtimeTracingConfigVariant1
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTracingConfigVariant1"
},
{
"$ref": "#/components/schemas/Input_RealtimeTracingConfigTracingConfiguration"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_tracing_config.py`, `RealtimeTracingConfig`."
}Input_RealtimeTracingConfigTracingConfiguration
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tracing_config.py`, `TracingConfiguration`.",
"properties": {
"group_id": {
"type": [
"string",
"null"
]
},
"metadata": true,
"workflow_name": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RealtimeTracingConfigVariant1
Complete JSON Schema
{
"enum": [
"auto"
],
"type": "string"
}Input_RealtimeTranscriptionSessionAudio
Complete JSON Schema
Referenced structures: Input_RealtimeTranscriptionSessionAudioInput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio.py`, `RealtimeTranscriptionSessionAudio`.",
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeTranscriptionSessionAudioInput
Complete JSON Schema
Referenced structures: Input_AudioTranscription2, Input_RealtimeAudioFormats, Input_RealtimeTranscriptionSessionAudioInputNoiseReduction, Input_RealtimeTranscriptionSessionAudioInputTurnDetection
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input.py`, `RealtimeTranscriptionSessionAudioInput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"noise_reduction": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInputNoiseReduction"
},
{
"type": "null"
}
]
},
"transcription": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioTranscription2"
},
{
"type": "null"
}
]
},
"turn_detection": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInputTurnDetection"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeTranscriptionSessionAudioInputNoiseReduction
Complete JSON Schema
Referenced structures: Input_NoiseReductionType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input.py`, `NoiseReduction`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_NoiseReductionType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RealtimeTranscriptionSessionAudioInputTurnDetection
Complete JSON Schema
Referenced structures: Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVad, Input_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVad
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVad"
},
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVad"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input_turn_detection.py`, `RealtimeTranscriptionSessionAudioInputTurnDetection`."
}Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVad
Complete JSON Schema
Referenced structures: Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadEagerness, Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input_turn_detection.py`, `SemanticVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"eagerness": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadEagerness"
},
{
"type": "null"
}
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadType"
}
},
"required": [
"type"
],
"type": "object"
}Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadEagerness
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"auto"
],
"type": "string"
}Input_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadType
Complete JSON Schema
{
"enum": [
"semantic_vad"
],
"type": "string"
}Input_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVad
Complete JSON Schema
Referenced structures: Input_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input_turn_detection.py`, `ServerVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"idle_timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"prefix_padding_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silence_duration_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVadType"
}
},
"required": [
"type"
],
"type": "object"
}Input_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVadType
Complete JSON Schema
{
"enum": [
"server_vad"
],
"type": "string"
}Input_RealtimeTranscriptionSessionCreateRequest
Complete JSON Schema
Referenced structures: Input_RealtimeTranscriptionSessionAudio, Input_RealtimeTranscriptionSessionCreateRequestIncludeItem, Input_RealtimeTranscriptionSessionCreateRequestType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_create_request.py`, `RealtimeTranscriptionSessionCreateRequest`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionAudio"
},
{
"type": "null"
}
]
},
"include": {
"items": {
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionCreateRequestIncludeItem"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionCreateRequestType"
}
},
"required": [
"type"
],
"type": "object"
}Input_RealtimeTranscriptionSessionCreateRequestIncludeItem
Complete JSON Schema
{
"enum": [
"item.input_audio_transcription.logprobs"
],
"type": "string"
}Input_RealtimeTranscriptionSessionCreateRequestType
Complete JSON Schema
{
"enum": [
"transcription"
],
"type": "string"
}Input_RealtimeTruncation
Complete JSON Schema
Referenced structures: Input_RealtimeTruncationRetentionRatio, Input_RealtimeTruncationVariant1
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTruncationVariant1"
},
{
"$ref": "#/components/schemas/Input_RealtimeTruncationRetentionRatio"
}
],
"description": "Source: `openai/types/realtime/realtime_truncation.py`, `RealtimeTruncation`."
}Input_RealtimeTruncationRetentionRatio
Complete JSON Schema
Referenced structures: Input_RealtimeTruncationRetentionRatioTokenLimits, Input_RealtimeTruncationRetentionRatioType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_truncation_retention_ratio.py`, `RealtimeTruncationRetentionRatio`.",
"properties": {
"retention_ratio": {
"type": "number"
},
"token_limits": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeTruncationRetentionRatioTokenLimits"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_RealtimeTruncationRetentionRatioType"
}
},
"required": [
"retention_ratio",
"type"
],
"type": "object"
}Input_RealtimeTruncationRetentionRatioTokenLimits
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_truncation_retention_ratio.py`, `TokenLimits`.",
"properties": {
"post_instructions": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_RealtimeTruncationRetentionRatioType
Complete JSON Schema
{
"enum": [
"retention_ratio"
],
"type": "string"
}Input_RealtimeTruncationVariant1
Complete JSON Schema
{
"enum": [
"auto",
"disabled"
],
"type": "string"
}Input_Reasoning
Complete JSON Schema
Referenced structures: Input_ReasoningContext2, Input_ReasoningSummary2
{
"additionalProperties": true,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningContext2"
},
{
"type": "null"
}
]
},
"effort": {
"type": [
"string",
"null"
]
},
"summary": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningSummary2"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ReasoningConfig
Complete JSON Schema
Referenced structures: Input_ReasoningContext, Input_ReasoningEffort, Input_ReasoningSummary
{
"additionalProperties": true,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningContext"
},
{
"type": "null"
}
]
},
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningEffort"
},
{
"type": "null"
}
]
},
"generate_summary": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningSummary"
},
{
"type": "null"
}
]
},
"mode": {
"type": [
"string",
"null"
]
},
"summary": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningSummary"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ReasoningContent
Complete JSON Schema
Referenced structures: Input_ReasoningTextType
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ReasoningTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_ReasoningContext
Complete JSON Schema
{
"enum": [
"auto",
"current_turn",
"all_turns"
],
"type": "string"
}Input_ReasoningContext2
Complete JSON Schema
{
"enum": [
"auto",
"current_turn",
"all_turns"
],
"type": "string"
}Input_ReasoningDetail
Complete JSON Schema
Referenced structures: Input_ReasoningDetailKind
{
"additionalProperties": true,
"description": "Payload fields are optional because streaming detail fragments may carry\nonly a signature or identity. Encrypted data is never interpreted as text.",
"properties": {
"data": {
"type": [
"string",
"null"
]
},
"format": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"index": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"signature": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ReasoningDetailKind"
}
},
"required": [
"type"
],
"type": "object"
}Input_ReasoningDetailKind
Complete JSON Schema
{
"enum": [
"reasoning.text",
"reasoning.summary",
"reasoning.encrypted"
],
"type": "string"
}Input_ReasoningEffort
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
],
"type": "string"
},
{
"description": "Codex custom effort is serialized as an unsigned JSON integer.",
"format": "uint64",
"minimum": 0,
"type": "integer"
}
]
}Input_ReasoningEffort2
Complete JSON Schema
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
],
"type": "string"
}Input_ReasoningItem
Complete JSON Schema
Referenced structures: Input_Agent, Input_ReasoningContent, Input_ReasoningItemType, Input_ReasoningStatus, Input_SummaryText
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Input_ReasoningContent"
},
"type": [
"array",
"null"
]
},
"encrypted_content": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ReasoningStatus"
},
{
"type": "null"
}
]
},
"summary": {
"items": {
"$ref": "#/components/schemas/Input_SummaryText"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_ReasoningItemType"
}
},
"required": [
"type",
"id",
"summary"
],
"type": "object"
}Input_ReasoningItemContent
Complete JSON Schema
Referenced structures: Input_ReasoningItemContentReasoningText, Input_ReasoningItemContentText
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ReasoningItemContentReasoningText",
"properties": {
"type": {
"const": "reasoning_text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ReasoningItemContentText",
"properties": {
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ReasoningItemContentReasoningText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_ReasoningItemContentText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_ReasoningItemReasoningSummary
Complete JSON Schema
Referenced structures: Input_ReasoningItemReasoningSummarySummaryText
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ReasoningItemReasoningSummarySummaryText",
"properties": {
"type": {
"const": "summary_text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ReasoningItemReasoningSummarySummaryText
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_ReasoningItemType
Complete JSON Schema
{
"enum": [
"reasoning"
],
"type": "string"
}Input_ReasoningStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete"
],
"type": "string"
}Input_ReasoningSummary
Complete JSON Schema
{
"enum": [
"auto",
"concise",
"detailed"
],
"type": "string"
}Input_ReasoningSummary2
Complete JSON Schema
{
"enum": [
"auto",
"concise",
"detailed",
"none"
],
"type": "string"
}Input_ReasoningTextType
Complete JSON Schema
{
"enum": [
"reasoning_text"
],
"type": "string"
}Input_RedactedThinkingBlock
Complete JSON Schema
Referenced structures: Input_RedactedThinkingBlockType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_RedactedThinkingBlockType"
}
},
"required": [
"type",
"data"
],
"type": "object"
}Input_RedactedThinkingBlockType
Complete JSON Schema
{
"enum": [
"redacted_thinking"
],
"type": "string"
}Input_RefusalPart
Complete JSON Schema
Referenced structures: Input_RefusalType
{
"additionalProperties": true,
"properties": {
"refusal": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_RefusalType"
}
},
"required": [
"type",
"refusal"
],
"type": "object"
}Input_RefusalType
Complete JSON Schema
{
"enum": [
"refusal"
],
"type": "string"
}Input_ReplayOutputText
Complete JSON Schema
Referenced structures: Input_OutputAnnotation, Input_OutputLogprob, Input_ResponseOutputTextType
{
"additionalProperties": true,
"properties": {
"annotations": {
"items": {
"$ref": "#/components/schemas/Input_OutputAnnotation"
},
"type": [
"array",
"null"
]
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Input_OutputLogprob"
},
"type": [
"array",
"null"
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ResponseOutputTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_ReplicatedVoiceConfig
Complete JSON Schema
Referenced structures: Input_VoiceConsentSignature
{
"additionalProperties": true,
"properties": {
"consentAudio": {
"type": [
"string",
"null"
]
},
"mimeType": {
"type": [
"string",
"null"
]
},
"voiceConsentSignature": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_VoiceConsentSignature"
},
{
"type": "null"
}
]
},
"voiceSampleAudio": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RequestMessage
Complete JSON Schema
Referenced structures: Input_GenerateContentRequestBody, Input_InjectRequest, Input_InterruptRequest, Input_SteerRequest
{
"description": "WS-only controls from the current official WebSocket mode guide.\nThey never enter the HTTP generation request body.",
"oneOf": [
{
"$ref": "#/components/schemas/Input_InjectRequest",
"properties": {
"type": {
"const": "response.inject",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_GenerateContentRequestBody",
"properties": {
"type": {
"const": "response.create",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_SteerRequest",
"properties": {
"type": {
"const": "response.steer",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_InterruptRequest",
"properties": {
"type": {
"const": "response.interrupt",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
],
"properties": {
"generate": {
"type": [
"boolean",
"null"
]
},
"stream_id": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RerankDocument
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"image": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RerankDocumentInput
Complete JSON Schema
Referenced structures: Input_RerankDocument
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_RerankDocument"
}
]
}Input_RerankRequestBody
Complete JSON Schema
Referenced structures: Input_ProviderPreferences, Input_RerankDocumentInput
{
"additionalProperties": true,
"properties": {
"documents": {
"items": {
"$ref": "#/components/schemas/Input_RerankDocumentInput"
},
"type": "array"
},
"model": {
"type": "string"
},
"provider": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ProviderPreferences"
},
{
"type": "null"
}
]
},
"query": {
"type": "string"
},
"top_n": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"model",
"query",
"documents"
],
"type": "object"
}Input_ResponseCancelEvent
Complete JSON Schema
Referenced structures: Input_ResponseCancelEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_cancel_event.py`, `ResponseCancelEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"response_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseCancelEventType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ResponseCancelEventType
Complete JSON Schema
{
"enum": [
"response.cancel"
],
"type": "string"
}Input_ResponseConversationParam
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Input_ResponseCreateEvent
Complete JSON Schema
Referenced structures: Input_RealtimeResponseCreateParams, Input_ResponseCreateEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_create_event.py`, `ResponseCreateEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"response": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeResponseCreateParams"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseCreateEventType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ResponseCreateEventType
Complete JSON Schema
{
"enum": [
"response.create"
],
"type": "string"
}Input_ResponseFormat
Complete JSON Schema
Referenced structures: Input_JsonObjectResponseFormat, Input_JsonSchemaResponseFormat, Input_TextResponseFormat2
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextResponseFormat2"
},
{
"$ref": "#/components/schemas/Input_JsonSchemaResponseFormat"
},
{
"$ref": "#/components/schemas/Input_JsonObjectResponseFormat"
}
]
}Input_ResponseFormatConfig
Complete JSON Schema
Referenced structures: Input_AudioResponseFormat, Input_ImageResponseFormat, Input_TextResponseFormat
{
"additionalProperties": true,
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_AudioResponseFormat"
},
{
"type": "null"
}
]
},
"image": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageResponseFormat"
},
{
"type": "null"
}
]
},
"text": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextResponseFormat"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ResponseIncludable
Complete JSON Schema
{
"enum": [
"web_search_call.action.sources",
"code_interpreter_call.outputs",
"computer_call_output.output.image_url",
"file_search_call.results",
"message.input_image.image_url",
"message.output_text.logprobs",
"reasoning.encrypted_content"
],
"type": "string"
}Input_ResponseInclusion
Complete JSON Schema
{
"enum": [
"full",
"excluded"
],
"type": "string"
}Input_ResponseInputFile
Complete JSON Schema
Referenced structures: Input_FileDetail, Input_PromptCacheBreakpoint, Input_ResponseInputFileType
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileDetail"
},
{
"type": "null"
}
]
},
"file_data": {
"type": [
"string",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"file_url": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputFileType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ResponseInputFile2
Complete JSON Schema
Referenced structures: Input_ResponseInputFileDetail, Input_ResponseInputFilePromptCacheBreakpoint, Input_ResponseInputFileType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_file.py`, `ResponseInputFile`.",
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInputFileDetail"
},
{
"type": "null"
}
]
},
"file_data": {
"type": [
"string",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"file_url": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInputFilePromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputFileType2"
}
},
"required": [
"type"
],
"type": "object"
}Input_ResponseInputFileDetail
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high"
],
"type": "string"
}Input_ResponseInputFilePromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Input_ResponseInputFilePromptCacheBreakpointMode
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_file.py`, `PromptCacheBreakpoint`.",
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_ResponseInputFilePromptCacheBreakpointMode"
}
},
"required": [
"mode"
],
"type": "object"
}Input_ResponseInputFilePromptCacheBreakpointMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Input_ResponseInputFileType
Complete JSON Schema
{
"enum": [
"input_file"
],
"type": "string"
}Input_ResponseInputFileType2
Complete JSON Schema
{
"enum": [
"input_file"
],
"type": "string"
}Input_ResponseInputImage
Complete JSON Schema
Referenced structures: Input_ImageDetail, Input_PromptCacheBreakpoint, Input_ResponseInputImageType
{
"additionalProperties": true,
"properties": {
"detail": {
"$ref": "#/components/schemas/Input_ImageDetail"
},
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputImageType"
}
},
"required": [
"type",
"detail"
],
"type": "object"
}Input_ResponseInputImage2
Complete JSON Schema
Referenced structures: Input_ImageDetail4, Input_ResponseInputImagePromptCacheBreakpoint, Input_ResponseInputImageType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_image.py`, `ResponseInputImage`.",
"properties": {
"detail": {
"$ref": "#/components/schemas/Input_ImageDetail4"
},
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInputImagePromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputImageType2"
}
},
"required": [
"detail",
"type"
],
"type": "object"
}Input_ResponseInputImagePromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Input_ResponseInputImagePromptCacheBreakpointMode
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_image.py`, `PromptCacheBreakpoint`.",
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_ResponseInputImagePromptCacheBreakpointMode"
}
},
"required": [
"mode"
],
"type": "object"
}Input_ResponseInputImagePromptCacheBreakpointMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Input_ResponseInputImageType
Complete JSON Schema
{
"enum": [
"input_image"
],
"type": "string"
}Input_ResponseInputImageType2
Complete JSON Schema
{
"enum": [
"input_image"
],
"type": "string"
}Input_ResponseInputText
Complete JSON Schema
Referenced structures: Input_PromptCacheBreakpoint, Input_ResponseInputTextType
{
"additionalProperties": true,
"properties": {
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_ResponseInputText2
Complete JSON Schema
Referenced structures: Input_ResponseInputTextPromptCacheBreakpoint, Input_ResponseInputTextType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_text.py`, `ResponseInputText`.",
"properties": {
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInputTextPromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ResponseInputTextType2"
}
},
"required": [
"text",
"type"
],
"type": "object"
}Input_ResponseInputTextPromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Input_ResponseInputTextPromptCacheBreakpointMode
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_text.py`, `PromptCacheBreakpoint`.",
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_ResponseInputTextPromptCacheBreakpointMode"
}
},
"required": [
"mode"
],
"type": "object"
}Input_ResponseInputTextPromptCacheBreakpointMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Input_ResponseInputTextType
Complete JSON Schema
{
"enum": [
"input_text"
],
"type": "string"
}Input_ResponseInputTextType2
Complete JSON Schema
{
"enum": [
"input_text"
],
"type": "string"
}Input_ResponseItemOther
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ResponseModeration
Complete JSON Schema
Referenced structures: Input_ModerationPolicy
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
},
"policy": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ModerationPolicy"
},
{
"type": "null"
}
]
}
},
"required": [
"model"
],
"type": "object"
}Input_ResponseOutputMessage
Complete JSON Schema
Referenced structures: Input_Agent, Input_MessagePhase, Input_MessageType, Input_OutputContent, Input_OutputMessageRole, Input_OutputMessageStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Input_OutputContent"
},
"type": "array"
},
"id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MessagePhase"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Input_OutputMessageRole"
},
"status": {
"$ref": "#/components/schemas/Input_OutputMessageStatus"
},
"type": {
"$ref": "#/components/schemas/Input_MessageType"
}
},
"required": [
"id",
"content",
"role",
"status",
"type"
],
"type": "object"
}Input_ResponseOutputRefusal
Complete JSON Schema
Referenced structures: Input_ResponseOutputRefusalType
{
"additionalProperties": true,
"properties": {
"refusal": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ResponseOutputRefusalType"
}
},
"required": [
"type",
"refusal"
],
"type": "object"
}Input_ResponseOutputRefusalType
Complete JSON Schema
{
"enum": [
"refusal"
],
"type": "string"
}Input_ResponseOutputText
Complete JSON Schema
Referenced structures: Input_OutputAnnotation, Input_OutputLogprob, Input_ResponseOutputTextType
{
"additionalProperties": true,
"properties": {
"annotations": {
"items": {
"$ref": "#/components/schemas/Input_OutputAnnotation"
},
"type": "array"
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Input_OutputLogprob"
},
"type": "array"
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ResponseOutputTextType"
}
},
"required": [
"type",
"text",
"annotations",
"logprobs"
],
"type": "object"
}Input_ResponseOutputTextType
Complete JSON Schema
{
"enum": [
"output_text"
],
"type": "string"
}Input_ResponsePrompt
Complete JSON Schema
Referenced structures: Input_PromptVariableValue
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"variables": {
"additionalProperties": {
"$ref": "#/components/schemas/Input_PromptVariableValue"
},
"type": [
"object",
"null"
]
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
}Input_ResponsePrompt2
Complete JSON Schema
Referenced structures: Input_ResponsePromptVariables
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_prompt.py`, `ResponsePrompt`.",
"properties": {
"id": {
"type": "string"
},
"variables": {
"additionalProperties": {
"$ref": "#/components/schemas/Input_ResponsePromptVariables"
},
"type": [
"object",
"null"
]
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
}Input_ResponsePromptVariables
Complete JSON Schema
Referenced structures: Input_ResponseInputFile2, Input_ResponseInputImage2, Input_ResponseInputText2
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_ResponseInputText2"
},
{
"$ref": "#/components/schemas/Input_ResponseInputImage2"
},
{
"$ref": "#/components/schemas/Input_ResponseInputFile2"
}
],
"description": "Source: `openai/types/responses/response_prompt.py`, `Variables`."
}Input_RetrievalConfig
Complete JSON Schema
Referenced structures: Input_LatLng
{
"additionalProperties": true,
"properties": {
"languageCode": {
"type": [
"string",
"null"
]
},
"latLng": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LatLng"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_RetrievalMode
Complete JSON Schema
{
"enum": [
"MODE_UNSPECIFIED",
"MODE_DYNAMIC"
],
"type": "string"
}Input_RevokeRequest
Complete JSON Schema
{
"description": "RFC 7009 §2.1.",
"properties": {
"client_id": {
"default": null,
"description": "When present, the token must belong to this client. A public client has\nno secret to prove with, so this cannot authorize a revocation — it can\nonly refuse one, which is the direction that matters.",
"type": [
"string",
"null"
]
},
"token": {
"default": "",
"type": "string"
},
"token_type_hint": {
"default": null,
"description": "`access_token` or `refresh_token`. A hint only: RFC 7009 §2.1 requires\nthe server to search the other kind anyway, so this is not used to\nnarrow anything.",
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RewriteRuleDto
Complete JSON Schema
{
"description": "One ordered replacement. Every write compiles the rule with core's own\ncompiler first, so a rule that would be skipped at assembly is refused\nhere instead of silently doing nothing.",
"properties": {
"action": {
"default": "replace",
"type": "string"
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"filterBody": {
"default": null
},
"filterEventPattern": {
"type": [
"string",
"null"
]
},
"filterHeader": {
"default": null
},
"filterHeaderPattern": {
"type": [
"string",
"null"
]
},
"filterModelPattern": {
"type": [
"string",
"null"
]
},
"filterOperationKeys": {
"description": "JSON array of `{\"operation\": …, \"dialect\": …}`."
},
"id": {
"type": "string"
},
"paths": {
"description": "JSON array of dot paths; body target only."
},
"pattern": {
"type": "string"
},
"phase": {
"description": "`request`, `response` or `both`.",
"type": "string"
},
"replacement": {
"type": "string"
},
"ruleSetId": {
"type": "string"
},
"sortOrder": {
"format": "int64",
"type": "integer"
},
"target": {
"description": "`body`, `header` or `query`.",
"type": "string"
},
"targetName": {
"type": [
"string",
"null"
]
},
"updatedAtMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"ruleSetId",
"phase",
"target",
"pattern",
"replacement",
"sortOrder",
"enabled",
"createdAtMs",
"updatedAtMs"
],
"type": "object"
}Input_RewriteRulePatch
Complete JSON Schema
{
"properties": {
"action": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"filterBody": {
"default": null
},
"filterEventPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterHeader": {
"default": null
},
"filterHeaderPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterModelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterOperationKeys": {
"default": null
},
"paths": {
"default": null
},
"pattern": {
"default": null,
"type": [
"string",
"null"
]
},
"phase": {
"default": null,
"type": [
"string",
"null"
]
},
"replacement": {
"default": null,
"type": [
"string",
"null"
]
},
"sortOrder": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"default": null,
"type": [
"string",
"null"
]
},
"targetName": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RewriteRuleWrite
Complete JSON Schema
{
"properties": {
"action": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"filterBody": {
"default": null
},
"filterEventPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterHeader": {
"default": null
},
"filterHeaderPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterModelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterOperationKeys": {
"default": null
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"paths": {
"default": null
},
"pattern": {
"type": "string"
},
"phase": {
"default": null,
"type": [
"string",
"null"
]
},
"replacement": {
"type": "string"
},
"ruleSetId": {
"default": null,
"description": "Ignored by `replace_rules`, which owns the set it is replacing.",
"type": [
"string",
"null"
]
},
"sortOrder": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"default": null,
"type": [
"string",
"null"
]
},
"targetName": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"pattern",
"replacement"
],
"type": "object"
}Input_Role
Complete JSON Schema
{
"enum": [
"user",
"assistant",
"system"
],
"type": "string"
}Input_RouteDto
Complete JSON Schema
{
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"maxAttempts": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "The exact model name clients send in requests.",
"type": "string"
},
"sessionAffinity": {
"default": false,
"type": "boolean"
},
"strategy": {
"description": "`round_robin`, `weighted` or `failover`.",
"type": "string"
}
},
"required": [
"id",
"name",
"strategy",
"maxAttempts",
"enabled"
],
"type": "object"
}Input_RouteMemberDto
Complete JSON Schema
{
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"providerId": {
"type": "string"
},
"routeId": {
"type": "string"
},
"tier": {
"description": "Lower tiers are preferred; later tiers are the fallback.",
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"upstreamModel": {
"description": "The upstream model this member sends, not a catalog reference.",
"type": "string"
},
"weight": {
"description": "Positive relative weight within a tier.",
"format": "uint32",
"minimum": 0,
"type": "integer"
}
},
"required": [
"id",
"routeId",
"providerId",
"upstreamModel",
"tier",
"weight",
"enabled"
],
"type": "object"
}Input_RouteMemberPatch
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"providerId": {
"default": null,
"type": [
"string",
"null"
]
},
"routeId": {
"default": null,
"type": [
"string",
"null"
]
},
"tier": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"upstreamModel": {
"default": null,
"type": [
"string",
"null"
]
},
"weight": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_RouteMemberWrite
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
},
"routeId": {
"type": "string"
},
"tier": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"upstreamModel": {
"type": "string"
},
"weight": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"routeId",
"providerId",
"upstreamModel"
],
"type": "object"
}Input_RoutePatch
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"maxAttempts": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"sessionAffinity": {
"default": null,
"type": [
"boolean",
"null"
]
},
"strategy": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RouteWrite
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"maxAttempts": {
"default": null,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"name": {
"description": "The exact model name clients send in requests.",
"type": "string"
},
"sessionAffinity": {
"default": null,
"type": [
"boolean",
"null"
]
},
"strategy": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_RoutingMappingWrite
Complete JSON Schema
Referenced structures: Input_RoutingTargetDto
{
"additionalProperties": false,
"properties": {
"implementation": {
"type": "string"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RoutingTargetDto"
},
{
"type": "null"
}
]
}
},
"required": [
"implementation"
],
"type": "object"
}Input_RoutingTargetDto
Complete JSON Schema
{
"description": "One exact operation/protocol key accepted by a conversion driver.",
"properties": {
"dialect": {
"type": "string"
},
"operation": {
"type": "string"
}
},
"required": [
"operation",
"dialect"
],
"type": "object"
}Input_RuleSetDto
Complete JSON Schema
{
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"description": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"providerCount": {
"description": "Number of provider attachments, populated by list/get.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"updatedAtMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"name",
"enabled",
"createdAtMs",
"updatedAtMs"
],
"type": "object"
}Input_RuleSetPatch
Complete JSON Schema
{
"properties": {
"description": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"name": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_RuleSetWrite
Complete JSON Schema
{
"properties": {
"description": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_SafetySetting
Complete JSON Schema
Referenced structures: Input_HarmBlockThreshold, Input_HarmCategory
{
"additionalProperties": true,
"properties": {
"category": {
"$ref": "#/components/schemas/Input_HarmCategory"
},
"threshold": {
"$ref": "#/components/schemas/Input_HarmBlockThreshold"
}
},
"required": [
"category",
"threshold"
],
"type": "object"
}Input_Scheduling
Complete JSON Schema
{
"enum": [
"SCHEDULING_UNSPECIFIED",
"SILENT",
"WHEN_IDLE",
"INTERRUPT"
],
"type": "string"
}Input_Schema
Complete JSON Schema
Referenced structures: Input_Schema, Input_SchemaType
{
"additionalProperties": true,
"properties": {
"anyOf": {
"items": {
"$ref": "#/components/schemas/Input_Schema"
},
"type": [
"array",
"null"
]
},
"default": true,
"description": {
"type": [
"string",
"null"
]
},
"enum": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"example": true,
"format": {
"type": [
"string",
"null"
]
},
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Schema"
},
{
"type": "null"
}
]
},
"maxItems": {
"type": [
"string",
"null"
]
},
"maxLength": {
"type": [
"string",
"null"
]
},
"maxProperties": {
"type": [
"string",
"null"
]
},
"maximum": {
"format": "double",
"type": [
"number",
"null"
]
},
"minItems": {
"type": [
"string",
"null"
]
},
"minLength": {
"type": [
"string",
"null"
]
},
"minProperties": {
"type": [
"string",
"null"
]
},
"minimum": {
"format": "double",
"type": [
"number",
"null"
]
},
"nullable": {
"type": [
"boolean",
"null"
]
},
"pattern": {
"type": [
"string",
"null"
]
},
"properties": {
"additionalProperties": {
"$ref": "#/components/schemas/Input_Schema"
},
"type": [
"object",
"null"
]
},
"propertyOrdering": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"required": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_SchemaType"
}
},
"required": [
"type"
],
"type": "object"
}Input_SchemaType
Complete JSON Schema
{
"enum": [
"TYPE_UNSPECIFIED",
"STRING",
"NUMBER",
"INTEGER",
"BOOLEAN",
"ARRAY",
"OBJECT",
"NULL"
],
"type": "string"
}Input_ScreenshotAction
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ScreenshotOperation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"pageno": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"ref_id": {
"type": "string"
}
},
"required": [
"ref_id",
"pageno"
],
"type": "object"
}Input_ScrollAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"scroll_x": {
"format": "int64",
"type": "integer"
},
"scroll_y": {
"format": "int64",
"type": "integer"
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"scroll_x",
"scroll_y",
"x",
"y"
],
"type": "object"
}Input_SealedSecretDto
Complete JSON Schema
{
"description": "A sealed secret as it travels: the envelope's own codec, and its bytes in\nstandard base64. Nothing here is plaintext, and nothing here can be opened\nwithout the key the source sealed it with.",
"properties": {
"bytes": {
"type": "string"
},
"codec": {
"description": "`plaintext`, `aes-gcm`, or `unknown` for an envelope this build does\nnot recognize. Carried so an importer can refuse early rather than\nafter decrypting nothing.",
"type": "string"
}
},
"required": [
"codec",
"bytes"
],
"type": "object"
}Input_SearchCitation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"end_block_index": {
"format": "int64",
"type": "integer"
},
"search_result_index": {
"format": "int64",
"type": "integer"
},
"source": {
"type": "string"
},
"start_block_index": {
"format": "int64",
"type": "integer"
},
"title": {
"type": "string"
}
},
"required": [
"cited_text",
"end_block_index",
"search_result_index",
"source",
"start_block_index",
"title"
],
"type": "object"
}Input_SearchCommands
Complete JSON Schema
Referenced structures: Input_ClickOperation, Input_FinanceOperation, Input_FindOperation, Input_OpenOperation, Input_ScreenshotOperation, Input_SearchQuery, Input_SearchResponseLength, Input_SportsOperation, Input_TimeOperation, Input_WeatherOperation
{
"additionalProperties": true,
"properties": {
"click": {
"items": {
"$ref": "#/components/schemas/Input_ClickOperation"
},
"type": [
"array",
"null"
]
},
"finance": {
"items": {
"$ref": "#/components/schemas/Input_FinanceOperation"
},
"type": [
"array",
"null"
]
},
"find": {
"items": {
"$ref": "#/components/schemas/Input_FindOperation"
},
"type": [
"array",
"null"
]
},
"image_query": {
"items": {
"$ref": "#/components/schemas/Input_SearchQuery"
},
"type": [
"array",
"null"
]
},
"open": {
"items": {
"$ref": "#/components/schemas/Input_OpenOperation"
},
"type": [
"array",
"null"
]
},
"response_length": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchResponseLength"
},
{
"type": "null"
}
]
},
"screenshot": {
"items": {
"$ref": "#/components/schemas/Input_ScreenshotOperation"
},
"type": [
"array",
"null"
]
},
"search_query": {
"items": {
"$ref": "#/components/schemas/Input_SearchQuery"
},
"type": [
"array",
"null"
]
},
"sports": {
"items": {
"$ref": "#/components/schemas/Input_SportsOperation"
},
"type": [
"array",
"null"
]
},
"time": {
"items": {
"$ref": "#/components/schemas/Input_TimeOperation"
},
"type": [
"array",
"null"
]
},
"weather": {
"items": {
"$ref": "#/components/schemas/Input_WeatherOperation"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_SearchContentType
Complete JSON Schema
{
"enum": [
"text",
"image"
],
"type": "string"
}Input_SearchContextSize
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
}Input_SearchContextSize2
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
}Input_SearchContextSize3
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
}Input_SearchFilters
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_SearchImageSettings
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"caption": {
"type": [
"boolean",
"null"
]
},
"max_results": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Input_SearchInput
Complete JSON Schema
Referenced structures: Input_ClientResponseItem
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_ClientResponseItem"
},
"type": "array"
}
]
}Input_SearchQuery
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"q": {
"type": "string"
},
"recency": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"q"
],
"type": "object"
}Input_SearchResponseLength
Complete JSON Schema
{
"enum": [
"short",
"medium",
"long"
],
"type": "string"
}Input_SearchResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_CitationsConfig, Input_SearchResultBlockType, Input_TextBlock
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"citations": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CitationsConfig"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Input_TextBlock"
},
"type": "array"
},
"source": {
"type": "string"
},
"title": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_SearchResultBlockType"
}
},
"required": [
"type",
"content",
"source",
"title"
],
"type": "object"
}Input_SearchResultBlockType
Complete JSON Schema
{
"enum": [
"search_result"
],
"type": "string"
}Input_SearchSettings
Complete JSON Schema
Referenced structures: Input_AllowedCaller3, Input_ApproximateLocation2, Input_ExternalWebAccess, Input_SearchContextSize3, Input_SearchFilters, Input_SearchImageSettings
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller3"
},
"type": [
"array",
"null"
]
},
"external_web_access": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ExternalWebAccess"
},
{
"type": "null"
}
]
},
"filters": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchFilters"
},
{
"type": "null"
}
]
},
"image_settings": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchImageSettings"
},
{
"type": "null"
}
]
},
"search_context_size": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchContextSize3"
},
{
"type": "null"
}
]
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ApproximateLocation2"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_SearchTypes
Complete JSON Schema
Referenced structures: Input_ImageSearch, Input_WebSearch
{
"additionalProperties": true,
"properties": {
"imageSearch": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ImageSearch"
},
{
"type": "null"
}
]
},
"webSearch": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_WebSearch"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ServerCaller
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"tool_id": {
"type": "string"
}
},
"required": [
"tool_id"
],
"type": "object"
}Input_ServerCaller20260120
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"tool_id": {
"type": "string"
}
},
"required": [
"tool_id"
],
"type": "object"
}Input_ServerToolName
Complete JSON Schema
{
"enum": [
"advisor",
"web_search",
"web_fetch",
"code_execution",
"bash_code_execution",
"text_editor_code_execution",
"tool_search_tool_regex",
"tool_search_tool_bm25"
],
"type": "string"
}Input_ServerToolUseBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_Caller2, Input_ServerToolName, Input_ServerToolUseBlockType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller2"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input": true,
"name": {
"$ref": "#/components/schemas/Input_ServerToolName"
},
"type": {
"$ref": "#/components/schemas/Input_ServerToolUseBlockType"
}
},
"required": [
"type",
"id",
"input",
"name"
],
"type": "object"
}Input_ServerToolUseBlockType
Complete JSON Schema
{
"enum": [
"server_tool_use"
],
"type": "string"
}Input_ServiceTier
Complete JSON Schema
{
"enum": [
"unspecified",
"standard",
"flex",
"priority"
],
"type": "string"
}Input_ServiceTier2
Complete JSON Schema
{
"enum": [
"auto",
"default",
"flex",
"scale",
"priority",
"fast",
"ultrafast"
],
"type": "string"
}Input_ServiceTier3
Complete JSON Schema
{
"enum": [
"auto",
"standard_only"
],
"type": "string"
}Input_ServiceTier4
Complete JSON Schema
{
"enum": [
"auto",
"default",
"flex",
"scale",
"priority",
"fast",
"ultrafast"
],
"type": "string"
}Input_ServiceTier5
Complete JSON Schema
{
"enum": [
"auto",
"default",
"fast",
"flex",
"priority"
],
"type": "string"
}Input_SessionResumptionConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"handle": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_SessionUpdateEvent
Complete JSON Schema
Referenced structures: Input_SessionUpdateEventSession, Input_SessionUpdateEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/session_update_event.py`, `SessionUpdateEvent`.",
"properties": {
"event_id": {
"type": [
"string",
"null"
]
},
"session": {
"$ref": "#/components/schemas/Input_SessionUpdateEventSession"
},
"type": {
"$ref": "#/components/schemas/Input_SessionUpdateEventType"
}
},
"required": [
"session",
"type"
],
"type": "object"
}Input_SessionUpdateEventSession
Complete JSON Schema
Referenced structures: Input_RealtimeSessionCreateRequest, Input_RealtimeTranscriptionSessionCreateRequest
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_RealtimeSessionCreateRequest"
},
{
"$ref": "#/components/schemas/Input_RealtimeTranscriptionSessionCreateRequest"
}
],
"description": "Source: `openai/types/realtime/session_update_event.py`, `Session`."
}Input_SessionUpdateEventType
Complete JSON Schema
{
"enum": [
"session.update"
],
"type": "string"
}Input_SettingsDto
Complete JSON Schema
Referenced structures: Input_InstanceSettingsDto, Input_LoggingSettingsDto
{
"properties": {
"instance": {
"$ref": "#/components/schemas/Input_InstanceSettingsDto"
},
"logging": {
"$ref": "#/components/schemas/Input_LoggingSettingsDto"
}
},
"required": [
"instance",
"logging"
],
"type": "object"
}Input_SettingsPatch
Complete JSON Schema
Referenced structures: Input_InstanceSettingsPatch, Input_LoggingSettingsPatch
{
"description": "Both groups are optional, and so is every field inside them: a patch names\nonly what changes.",
"properties": {
"instance": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_InstanceSettingsPatch"
},
{
"type": "null"
}
],
"default": null
},
"logging": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LoggingSettingsPatch"
},
{
"type": "null"
}
],
"default": null
}
},
"type": "object"
}Input_ShellAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"commands": {
"items": {
"type": "string"
},
"type": "array"
},
"max_output_length": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"commands"
],
"type": "object"
}Input_ShellCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_Caller, Input_ItemStatus, Input_ShellAction, Input_ShellCallEnvironment, Input_ShellCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Input_ShellAction"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"environment": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ShellCallEnvironment"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ShellCallType"
}
},
"required": [
"type",
"call_id",
"action"
],
"type": "object"
}Input_ShellCallEnvironment
Complete JSON Schema
Referenced structures: Input_ShellContainerReference, Input_ShellLocalEnvironment
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ShellLocalEnvironment"
},
{
"$ref": "#/components/schemas/Input_ShellContainerReference"
}
]
}Input_ShellCallOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_Caller, Input_ItemStatus, Input_ShellCallOutputType, Input_ShellOutputContent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"max_output_length": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output": {
"items": {
"$ref": "#/components/schemas/Input_ShellOutputContent"
},
"type": "array"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ShellCallOutputType"
}
},
"required": [
"type",
"call_id",
"output"
],
"type": "object"
}Input_ShellCallOutputType
Complete JSON Schema
{
"enum": [
"shell_call_output"
],
"type": "string"
}Input_ShellCallType
Complete JSON Schema
{
"enum": [
"shell_call"
],
"type": "string"
}Input_ShellContainerAuto
Complete JSON Schema
Referenced structures: Input_ContainerNetworkPolicy, Input_MemoryLimit, Input_ShellContainerAutoType, Input_ShellSkill
{
"additionalProperties": true,
"properties": {
"file_ids": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"memory_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MemoryLimit"
},
{
"type": "null"
}
]
},
"network_policy": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ContainerNetworkPolicy"
},
{
"type": "null"
}
]
},
"skills": {
"items": {
"$ref": "#/components/schemas/Input_ShellSkill"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ShellContainerAutoType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ShellContainerAutoType
Complete JSON Schema
{
"enum": [
"container_auto"
],
"type": "string"
}Input_ShellContainerReference
Complete JSON Schema
Referenced structures: Input_ShellReferenceType
{
"additionalProperties": true,
"properties": {
"container_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ShellReferenceType"
}
},
"required": [
"type",
"container_id"
],
"type": "object"
}Input_ShellEnvironment
Complete JSON Schema
Referenced structures: Input_ShellContainerAuto, Input_ShellContainerReference, Input_ShellLocalEnvironment
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ShellContainerAuto"
},
{
"$ref": "#/components/schemas/Input_ShellLocalEnvironment"
},
{
"$ref": "#/components/schemas/Input_ShellContainerReference"
}
]
}Input_ShellExit
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"exit_code": {
"format": "int64",
"type": "integer"
}
},
"required": [
"exit_code"
],
"type": "object"
}Input_ShellLocalEnvironment
Complete JSON Schema
Referenced structures: Input_LocalSkill, Input_ShellLocalType
{
"additionalProperties": true,
"properties": {
"skills": {
"items": {
"$ref": "#/components/schemas/Input_LocalSkill"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ShellLocalType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ShellLocalType
Complete JSON Schema
{
"enum": [
"local"
],
"type": "string"
}Input_ShellOutputContent
Complete JSON Schema
Referenced structures: Input_ShellOutputOutcome
{
"additionalProperties": true,
"properties": {
"outcome": {
"$ref": "#/components/schemas/Input_ShellOutputOutcome"
},
"stderr": {
"type": "string"
},
"stdout": {
"type": "string"
}
},
"required": [
"stdout",
"stderr",
"outcome"
],
"type": "object"
}Input_ShellOutputOutcome
Complete JSON Schema
Referenced structures: Input_ShellExit, Input_ShellTimeout
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ShellTimeout",
"properties": {
"type": {
"const": "timeout",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ShellExit",
"properties": {
"type": {
"const": "exit",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ShellReferenceType
Complete JSON Schema
{
"enum": [
"container_reference"
],
"type": "string"
}Input_ShellSkill
Complete JSON Schema
Referenced structures: Input_InlineSkill, Input_SkillReference
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_SkillReference"
},
{
"$ref": "#/components/schemas/Input_InlineSkill"
}
]
}Input_ShellTimeout
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ShellTool
Complete JSON Schema
Referenced structures: Input_AllowedCaller, Input_ShellEnvironment
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"environment": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ShellEnvironment"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_SkillParam
Complete JSON Schema
Referenced structures: Input_SkillType
{
"additionalProperties": true,
"properties": {
"skill_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_SkillType"
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"skill_id",
"type"
],
"type": "object"
}Input_SkillReference
Complete JSON Schema
Referenced structures: Input_SkillReferenceType
{
"additionalProperties": true,
"properties": {
"skill_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_SkillReferenceType"
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"skill_id",
"type"
],
"type": "object"
}Input_SkillReferenceType
Complete JSON Schema
{
"enum": [
"skill_reference"
],
"type": "string"
}Input_SkillType
Complete JSON Schema
{
"enum": [
"anthropic",
"custom"
],
"type": "string"
}Input_SlidingWindow
Complete JSON Schema
Referenced structures: Input_LiveInt64
{
"additionalProperties": true,
"properties": {
"targetTokens": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_LiveInt64"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_SpeakerVoiceConfig
Complete JSON Schema
Referenced structures: Input_VoiceConfig
{
"additionalProperties": true,
"properties": {
"speaker": {
"type": "string"
},
"voiceConfig": {
"$ref": "#/components/schemas/Input_VoiceConfig"
}
},
"required": [
"speaker",
"voiceConfig"
],
"type": "object"
}Input_SpeechConfig
Complete JSON Schema
Referenced structures: Input_MultiSpeakerVoiceConfig, Input_VoiceConfig
{
"additionalProperties": true,
"properties": {
"languageCode": {
"type": [
"string",
"null"
]
},
"multiSpeakerVoiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MultiSpeakerVoiceConfig"
},
{
"type": "null"
}
]
},
"voiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_VoiceConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_SpeechMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"speaker": {
"type": [
"string",
"null"
]
},
"style": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_SpeechStreamFormat
Complete JSON Schema
{
"enum": [
"sse",
"audio"
],
"type": "string"
}Input_SpeechVoice
Complete JSON Schema
Referenced structures: Input_CustomVoice2
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Input_CustomVoice2"
}
]
}Input_Speed
Complete JSON Schema
{
"enum": [
"standard",
"fast"
],
"type": "string"
}Input_SportsFunction
Complete JSON Schema
{
"enum": [
"schedule",
"standings"
],
"type": "string"
}Input_SportsLeague
Complete JSON Schema
{
"enum": [
"nba",
"wnba",
"nfl",
"nhl",
"mlb",
"epl",
"ncaamb",
"ncaawb",
"ipl"
],
"type": "string"
}Input_SportsOperation
Complete JSON Schema
Referenced structures: Input_SportsFunction, Input_SportsLeague, Input_SportsToolName
{
"additionalProperties": true,
"properties": {
"date_from": {
"type": [
"string",
"null"
]
},
"date_to": {
"type": [
"string",
"null"
]
},
"fn": {
"$ref": "#/components/schemas/Input_SportsFunction"
},
"league": {
"$ref": "#/components/schemas/Input_SportsLeague"
},
"locale": {
"type": [
"string",
"null"
]
},
"num_games": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"opponent": {
"type": [
"string",
"null"
]
},
"team": {
"type": [
"string",
"null"
]
},
"tool": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SportsToolName"
},
{
"type": "null"
}
]
}
},
"required": [
"fn",
"league"
],
"type": "object"
}Input_SportsToolName
Complete JSON Schema
{
"enum": [
"sports"
],
"type": "string"
}Input_StartSensitivity
Complete JSON Schema
{
"enum": [
"START_SENSITIVITY_UNSPECIFIED",
"START_SENSITIVITY_HIGH",
"START_SENSITIVITY_LOW"
],
"type": "string"
}Input_Status
Complete JSON Schema
Referenced structures: Input_StatusDetail
{
"additionalProperties": true,
"properties": {
"code": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"details": {
"items": {
"$ref": "#/components/schemas/Input_StatusDetail"
},
"type": [
"array",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_StatusBody
Complete JSON Schema
Referenced structures: Input_CredentialStatus
{
"properties": {
"reason": {
"default": null,
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Input_CredentialStatus"
}
},
"required": [
"status"
],
"type": "object"
}Input_StatusDetail
Complete JSON Schema
{
"additionalProperties": true,
"description": "google.rpc.Status.details is a list of protobuf Any objects. Discovery\nexplicitly permits arbitrary payload properties; @type identifies their schema.",
"properties": {
"@type": {
"type": "string"
}
},
"required": [
"@type"
],
"type": "object"
}Input_SteerInput
Complete JSON Schema
Referenced structures: Input_SteerMessage
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_SteerMessage"
},
"type": "array"
}
]
}Input_SteerMessage
Complete JSON Schema
Referenced structures: Input_MessageContent, Input_MessageType, Input_SteerRole
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_MessageContent"
},
"role": {
"$ref": "#/components/schemas/Input_SteerRole"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_MessageType"
},
{
"type": "null"
}
]
}
},
"required": [
"role",
"content"
],
"type": "object"
}Input_SteerRequest
Complete JSON Schema
Referenced structures: Input_SteerInput
{
"additionalProperties": true,
"properties": {
"input": {
"$ref": "#/components/schemas/Input_SteerInput"
},
"previous_response_id": {
"type": "string"
}
},
"required": [
"previous_response_id",
"input"
],
"type": "object"
}Input_SteerRole
Complete JSON Schema
{
"enum": [
"user"
],
"type": "string"
}Input_Stop
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}Input_StreamOptions
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"include_obfuscation": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_StreamOptions2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"include_obfuscation": {
"type": [
"boolean",
"null"
]
},
"include_usage": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_StreamableHttpTransport
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"headers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"sseReadTimeout": {
"type": [
"string",
"null"
]
},
"terminateOnClose": {
"type": [
"boolean",
"null"
]
},
"timeout": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}Input_StringOrTextParts
Complete JSON Schema
Referenced structures: Input_TextPart
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_TextPart"
},
"type": "array"
}
]
}Input_SummaryText
Complete JSON Schema
Referenced structures: Input_SummaryTextType
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_SummaryTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_SummaryTextType
Complete JSON Schema
{
"enum": [
"summary_text"
],
"type": "string"
}Input_SystemMessage
Complete JSON Schema
Referenced structures: Input_StringOrTextParts, Input_SystemRole
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_StringOrTextParts"
},
"name": {
"type": [
"string",
"null"
]
},
"role": {
"$ref": "#/components/schemas/Input_SystemRole"
}
},
"required": [
"role",
"content"
],
"type": "object"
}Input_SystemMessageClearAt
Complete JSON Schema
{
"enum": [
"next_user_message",
"never"
],
"type": "string"
}Input_SystemMessageOutputConfig
Complete JSON Schema
Referenced structures: Input_Effort
{
"additionalProperties": true,
"properties": {
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Effort"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_SystemPrompt
Complete JSON Schema
Referenced structures: Input_TextBlock
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_TextBlock"
},
"type": "array"
}
]
}Input_SystemRole
Complete JSON Schema
{
"enum": [
"system"
],
"type": "string"
}Input_TeamPatch
Complete JSON Schema
{
"properties": {
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"oauthClientAllowlist": {
"default": null,
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_TeamWrite
Complete JSON Schema
{
"properties": {
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"oauthClientAllowlist": {
"default": null,
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"organizationId": {
"type": "string"
}
},
"required": [
"organizationId",
"name"
],
"type": "object"
}Input_TextBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_TextBlockType, Input_TextCitation
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"citations": {
"items": {
"$ref": "#/components/schemas/Input_TextCitation"
},
"type": [
"array",
"null"
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_TextBlockType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_TextBlockType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Input_TextCitation
Complete JSON Schema
Referenced structures: Input_CharCitation, Input_ContentBlockCitation, Input_PageCitation, Input_SearchCitation, Input_WebCitation
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_CharCitation",
"properties": {
"type": {
"const": "char_location",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_PageCitation",
"properties": {
"type": {
"const": "page_location",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ContentBlockCitation",
"properties": {
"type": {
"const": "content_block_location",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebCitation",
"properties": {
"type": {
"const": "web_search_result_location",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_SearchCitation",
"properties": {
"type": {
"const": "search_result_location",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_TextConfig
Complete JSON Schema
Referenced structures: Input_TextFormat, Input_TextVerbosity
{
"additionalProperties": true,
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextFormat"
},
{
"type": "null"
}
]
},
"verbosity": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextVerbosity"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_TextEditorCodeExecutionToolResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_TextEditorCodeExecutionToolResultType, Input_TextEditorResultContent
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_TextEditorResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorCodeExecutionToolResultType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Input_TextEditorCodeExecutionToolResultType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_tool_result"
],
"type": "string"
}Input_TextEditorCreateResult
Complete JSON Schema
Referenced structures: Input_TextEditorCreateResultType
{
"additionalProperties": true,
"properties": {
"is_file_update": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorCreateResultType"
}
},
"required": [
"type",
"is_file_update"
],
"type": "object"
}Input_TextEditorCreateResultType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_create_result"
],
"type": "string"
}Input_TextEditorError
Complete JSON Schema
Referenced structures: Input_TextEditorErrorCode, Input_TextEditorErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Input_TextEditorErrorCode"
},
"error_message": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Input_TextEditorErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded",
"file_not_found"
],
"type": "string"
}Input_TextEditorErrorType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_tool_result_error"
],
"type": "string"
}Input_TextEditorFileType
Complete JSON Schema
{
"enum": [
"text",
"image",
"pdf"
],
"type": "string"
}Input_TextEditorReplaceResult
Complete JSON Schema
Referenced structures: Input_TextEditorReplaceResultType
{
"additionalProperties": true,
"properties": {
"lines": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"new_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_start": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"old_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"old_start": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorReplaceResultType"
}
},
"required": [
"type"
],
"type": "object"
}Input_TextEditorReplaceResultType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_str_replace_result"
],
"type": "string"
}Input_TextEditorResultContent
Complete JSON Schema
Referenced structures: Input_TextEditorCreateResult, Input_TextEditorError, Input_TextEditorReplaceResult, Input_TextEditorViewResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextEditorError"
},
{
"$ref": "#/components/schemas/Input_TextEditorViewResult"
},
{
"$ref": "#/components/schemas/Input_TextEditorCreateResult"
},
{
"$ref": "#/components/schemas/Input_TextEditorReplaceResult"
}
]
}Input_TextEditorTool20241022
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_TextEditorTool20241022Name, Input_TextEditorTool20241022Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_TextEditorTool20241022Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorTool20241022Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_TextEditorTool20241022Name
Complete JSON Schema
{
"enum": [
"str_replace_editor"
],
"type": "string"
}Input_TextEditorTool20241022Type
Complete JSON Schema
{
"enum": [
"text_editor_20241022"
],
"type": "string"
}Input_TextEditorTool20250124
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_TextEditorTool20250124Name, Input_TextEditorTool20250124Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_TextEditorTool20250124Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorTool20250124Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_TextEditorTool20250124Name
Complete JSON Schema
{
"enum": [
"str_replace_editor"
],
"type": "string"
}Input_TextEditorTool20250124Type
Complete JSON Schema
{
"enum": [
"text_editor_20250124"
],
"type": "string"
}Input_TextEditorTool20250429
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_TextEditorTool20250429Name, Input_TextEditorTool20250429Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_TextEditorTool20250429Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorTool20250429Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_TextEditorTool20250429Name
Complete JSON Schema
{
"enum": [
"str_replace_based_edit_tool"
],
"type": "string"
}Input_TextEditorTool20250429Type
Complete JSON Schema
{
"enum": [
"text_editor_20250429"
],
"type": "string"
}Input_TextEditorTool20250728
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_TextEditorTool20250728Name, Input_TextEditorTool20250728Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"max_characters": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_TextEditorTool20250728Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorTool20250728Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_TextEditorTool20250728Name
Complete JSON Schema
{
"enum": [
"str_replace_based_edit_tool"
],
"type": "string"
}Input_TextEditorTool20250728Type
Complete JSON Schema
{
"enum": [
"text_editor_20250728"
],
"type": "string"
}Input_TextEditorViewResult
Complete JSON Schema
Referenced structures: Input_TextEditorFileType, Input_TextEditorViewResultType
{
"additionalProperties": true,
"properties": {
"content": {
"type": "string"
},
"file_type": {
"$ref": "#/components/schemas/Input_TextEditorFileType"
},
"num_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"start_line": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_TextEditorViewResultType"
}
},
"required": [
"type",
"content",
"file_type"
],
"type": "object"
}Input_TextEditorViewResultType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_view_result"
],
"type": "string"
}Input_TextFormat
Complete JSON Schema
Referenced structures: Input_TextFormatJsonObject, Input_TextFormatJsonSchema, Input_TextFormatText
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_TextFormatText",
"properties": {
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_TextFormatJsonSchema",
"properties": {
"type": {
"const": "json_schema",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_TextFormatJsonObject",
"properties": {
"type": {
"const": "json_object",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_TextFormat2
Complete JSON Schema
Referenced structures: Input_TextFormatType2
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_TextFormatType2"
}
},
"required": [
"type"
],
"type": "object"
}Input_TextFormatJsonObject
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_TextFormatJsonSchema
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"schema": {
"additionalProperties": true,
"type": "object"
},
"strict": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"schema"
],
"type": "object"
}Input_TextFormatText
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_TextFormatType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Input_TextFormatType2
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Input_TextMediaType
Complete JSON Schema
{
"enum": [
"text/plain"
],
"type": "string"
}Input_TextMimeType
Complete JSON Schema
{
"enum": [
"MIME_TYPE_UNSPECIFIED",
"APPLICATION_JSON",
"TEXT_PLAIN"
],
"type": "string"
}Input_TextPart
Complete JSON Schema
Referenced structures: Input_PromptCacheBreakpoint2, Input_TextPartType
{
"additionalProperties": true,
"properties": {
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PromptCacheBreakpoint2"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_TextPartType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Input_TextPartType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Input_TextResponseFormat
Complete JSON Schema
Referenced structures: Input_TextMimeType
{
"additionalProperties": true,
"properties": {
"mimeType": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextMimeType"
},
{
"type": "null"
}
]
},
"schema": true
},
"type": "object"
}Input_TextResponseFormat2
Complete JSON Schema
Referenced structures: Input_TextResponseType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_TextResponseType"
}
},
"required": [
"type"
],
"type": "object"
}Input_TextResponseType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Input_TextVerbosity
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
}Input_ThinkingAdaptive
Complete JSON Schema
Referenced structures: Input_ThinkingBlockBinding, Input_ThinkingDisplay
{
"additionalProperties": true,
"properties": {
"block_binding": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingBlockBinding"
},
{
"type": "null"
}
]
},
"display": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingDisplay"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ThinkingBlock
Complete JSON Schema
Referenced structures: Input_ThinkingBlockType
{
"additionalProperties": true,
"properties": {
"signature": {
"type": "string"
},
"thinking": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ThinkingBlockType"
}
},
"required": [
"type",
"signature",
"thinking"
],
"type": "object"
}Input_ThinkingBlockBinding
Complete JSON Schema
Referenced structures: Input_ThinkingPrefixMismatchBehavior
{
"additionalProperties": true,
"properties": {
"prefix_mismatch_behavior": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingPrefixMismatchBehavior"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ThinkingBlockType
Complete JSON Schema
{
"enum": [
"thinking"
],
"type": "string"
}Input_ThinkingConfig
Complete JSON Schema
Referenced structures: Input_ThinkingAdaptive, Input_ThinkingDisabled, Input_ThinkingEnabled
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ThinkingEnabled",
"properties": {
"type": {
"const": "enabled",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ThinkingDisabled",
"properties": {
"type": {
"const": "disabled",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ThinkingAdaptive",
"properties": {
"type": {
"const": "adaptive",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"description": "No up-front thinking; progress updates between tool calls (Sonnet 5.5).",
"properties": {
"type": {
"const": "between_tools",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ThinkingConfig2
Complete JSON Schema
Referenced structures: Input_ThinkingLevel
{
"additionalProperties": true,
"properties": {
"includeThoughts": {
"type": [
"boolean",
"null"
]
},
"thinkingBudget": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"thinkingLevel": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingLevel"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ThinkingDisabled
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ThinkingDisplay
Complete JSON Schema
{
"enum": [
"summarized",
"omitted",
"updates"
],
"type": "string"
}Input_ThinkingEnabled
Complete JSON Schema
Referenced structures: Input_ThinkingBlockBinding, Input_ThinkingDisplay
{
"additionalProperties": true,
"properties": {
"block_binding": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingBlockBinding"
},
{
"type": "null"
}
]
},
"budget_tokens": {
"format": "int64",
"type": "integer"
},
"display": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingDisplay"
},
{
"type": "null"
}
]
}
},
"required": [
"budget_tokens"
],
"type": "object"
}Input_ThinkingKeep
Complete JSON Schema
Referenced structures: Input_AllStringThinkingTurns, Input_AllThinkingTurns, Input_ThinkingTurns
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ThinkingTurns"
},
{
"$ref": "#/components/schemas/Input_AllThinkingTurns"
},
{
"$ref": "#/components/schemas/Input_AllStringThinkingTurns"
}
]
}Input_ThinkingLevel
Complete JSON Schema
{
"enum": [
"THINKING_LEVEL_UNSPECIFIED",
"MINIMAL",
"LOW",
"MEDIUM",
"HIGH"
],
"type": "string"
}Input_ThinkingPrefixMismatchBehavior
Complete JSON Schema
{
"enum": [
"error",
"drop_block"
],
"type": "string"
}Input_ThinkingTurns
Complete JSON Schema
Referenced structures: Input_ThinkingTurnsType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_ThinkingTurnsType"
},
"value": {
"format": "int64",
"type": "integer"
}
},
"required": [
"type",
"value"
],
"type": "object"
}Input_ThinkingTurnsType
Complete JSON Schema
{
"enum": [
"thinking_turns"
],
"type": "string"
}Input_TimeOperation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"utc_offset": {
"type": "string"
}
},
"required": [
"utc_offset"
],
"type": "object"
}Input_TokenBody
Complete JSON Schema
{
"properties": {
"token": {
"default": null,
"description": "`null` clears the token and downloads anonymously again.",
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_TokenRequest
Complete JSON Schema
{
"description": "RFC 6749 §4.1.3 / §6 and RFC 8628 §3.4, in one shape.\n\nWhich fields must be present depends on `grant_type`, so all of them are\noptional here and the issuer names what is missing. That is deliberate: a\nclient that sends `code` with `grant_type=refresh_token` deserves\n`invalid_request: refresh_token is required`, not a parse error listing\nevery field of every grant type.",
"properties": {
"client_id": {
"default": "",
"description": "Required for every grant type. These are public clients — there is no\nclient secret to authenticate with — so this names the client and is\nchecked against the grant, never trusted on its own.",
"type": "string"
},
"code": {
"default": null,
"type": [
"string",
"null"
]
},
"code_verifier": {
"default": null,
"type": [
"string",
"null"
]
},
"device_code": {
"default": null,
"type": [
"string",
"null"
]
},
"grant_type": {
"default": "",
"description": "`authorization_code`, `refresh_token` or [`DEVICE_GRANT_TYPE`].",
"type": "string"
},
"redirect_uri": {
"default": null,
"type": [
"string",
"null"
]
},
"refresh_token": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_TokenTaskBudget
Complete JSON Schema
Referenced structures: Input_TokenTaskBudgetType
{
"additionalProperties": true,
"properties": {
"remaining": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"total": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Input_TokenTaskBudgetType"
}
},
"required": [
"total",
"type"
],
"type": "object"
}Input_TokenTaskBudgetType
Complete JSON Schema
{
"enum": [
"tokens"
],
"type": "string"
}Input_TokenizerFetch
Complete JSON Schema
{
"description": "What to fetch, and what to point at it.",
"properties": {
"filename": {
"default": null,
"description": "The file inside it; `tokenizer.json` when absent.",
"type": [
"string",
"null"
]
},
"modelId": {
"default": null,
"description": "The catalog model whose `vocabulary_file_id` should point at the\nresult. Absent leaves every model alone.",
"type": [
"string",
"null"
]
},
"repo": {
"description": "A Hugging Face repository id, `owner/name`.",
"type": "string"
},
"setAsDefault": {
"default": false,
"description": "Whether this also becomes the instance default, used by models that\nselect no vocabulary of their own.",
"type": "boolean"
}
},
"required": [
"repo"
],
"type": "object"
}Input_Tool
Complete JSON Schema
Referenced structures: Input_ApplyPatchTool, Input_CodeInterpreterTool, Input_ComputerTool, Input_CustomTool, Input_FileSearchTool, Input_FunctionTool, Input_ImageGenerationTool, Input_McpTool, Input_NamespaceTool, Input_ShellTool, Input_ToolMarker, Input_ToolSearchTool, Input_WebSearchPreviewTool, Input_WebSearchTool
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_FunctionTool",
"properties": {
"type": {
"const": "function",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_FileSearchTool",
"properties": {
"type": {
"const": "file_search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ComputerTool",
"properties": {
"type": {
"const": "computer_use_preview",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ToolMarker",
"properties": {
"type": {
"const": "computer",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchPreviewTool",
"properties": {
"type": {
"const": "web_search_preview",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchPreviewTool",
"properties": {
"type": {
"const": "web_search_preview_2025_03_11",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchTool",
"properties": {
"type": {
"const": "web_search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchTool",
"properties": {
"type": {
"const": "web_search_2025_08_26",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_CodeInterpreterTool",
"properties": {
"type": {
"const": "code_interpreter",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_CustomTool",
"properties": {
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_NamespaceTool",
"properties": {
"type": {
"const": "namespace",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ToolMarker",
"properties": {
"type": {
"const": "local_shell",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ShellTool",
"properties": {
"type": {
"const": "shell",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ImageGenerationTool",
"properties": {
"type": {
"const": "image_generation",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_McpTool",
"properties": {
"type": {
"const": "mcp",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ToolMarker",
"properties": {
"type": {
"const": "programmatic_tool_calling",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ApplyPatchTool",
"properties": {
"type": {
"const": "apply_patch",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ToolSearchTool",
"properties": {
"type": {
"const": "tool_search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_Tool2
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_JsonSchema, Input_ToolType
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"eager_input_streaming": {
"type": [
"boolean",
"null"
]
},
"input_examples": {
"items": true,
"type": [
"array",
"null"
]
},
"input_schema": {
"$ref": "#/components/schemas/Input_JsonSchema"
},
"name": {
"type": "string"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolType"
},
{
"type": "null"
}
]
}
},
"required": [
"input_schema",
"name"
],
"type": "object"
}Input_Tool3
Complete JSON Schema
Referenced structures: Input_CodeExecution, Input_ComputerUse, Input_FileSearch, Input_FunctionDeclaration, Input_GoogleMaps, Input_GoogleSearch, Input_GoogleSearchRetrieval, Input_McpServer, Input_UrlContext
{
"additionalProperties": true,
"properties": {
"codeExecution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CodeExecution"
},
{
"type": "null"
}
]
},
"computerUse": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ComputerUse"
},
{
"type": "null"
}
]
},
"fileSearch": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileSearch"
},
{
"type": "null"
}
]
},
"functionDeclarations": {
"items": {
"$ref": "#/components/schemas/Input_FunctionDeclaration"
},
"type": [
"array",
"null"
]
},
"googleMaps": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GoogleMaps"
},
{
"type": "null"
}
]
},
"googleSearch": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GoogleSearch"
},
{
"type": "null"
}
]
},
"googleSearchRetrieval": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_GoogleSearchRetrieval"
},
{
"type": "null"
}
]
},
"mcpServers": {
"items": {
"$ref": "#/components/schemas/Input_McpServer"
},
"type": [
"array",
"null"
]
},
"urlContext": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_UrlContext"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ToolAdditionBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ToolAdditionReference, Input_ToolAdditionType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"tool": {
"$ref": "#/components/schemas/Input_ToolAdditionReference"
},
"type": {
"$ref": "#/components/schemas/Input_ToolAdditionType"
}
},
"required": [
"type",
"tool"
],
"type": "object"
}Input_ToolAdditionReference
Complete JSON Schema
Referenced structures: Input_McpToolReference, Input_McpToolsetReference, Input_ToolDefinition, Input_ToolReference
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolReference"
},
{
"$ref": "#/components/schemas/Input_McpToolReference"
},
{
"$ref": "#/components/schemas/Input_McpToolsetReference"
},
{
"$ref": "#/components/schemas/Input_ToolDefinition"
}
]
}Input_ToolAdditionType
Complete JSON Schema
{
"enum": [
"tool_addition"
],
"type": "string"
}Input_ToolCall
Complete JSON Schema
Referenced structures: Input_ToolType2
{
"additionalProperties": true,
"properties": {
"args": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"toolName": {
"type": [
"string",
"null"
]
},
"toolType": {
"$ref": "#/components/schemas/Input_ToolType2"
}
},
"required": [
"toolType"
],
"type": "object"
}Input_ToolChangeReference
Complete JSON Schema
Referenced structures: Input_McpToolReference, Input_McpToolsetReference, Input_ToolReference
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolReference"
},
{
"$ref": "#/components/schemas/Input_McpToolReference"
},
{
"$ref": "#/components/schemas/Input_McpToolsetReference"
}
]
}Input_ToolChoice
Complete JSON Schema
Referenced structures: Input_ToolChoiceAllowed, Input_ToolChoiceApplyPatch, Input_ToolChoiceCustom, Input_ToolChoiceFunction, Input_ToolChoiceHosted, Input_ToolChoiceMcp, Input_ToolChoiceMode, Input_ToolChoiceProgrammatic, Input_ToolChoiceShell
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoiceMode"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceAllowed"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceHosted"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceFunction"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceMcp"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceCustom"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceProgrammatic"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceApplyPatch"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceShell"
}
]
}Input_ToolChoice2
Complete JSON Schema
Referenced structures: Input_ToolChoiceAny, Input_ToolChoiceAuto, Input_ToolChoiceNone, Input_ToolChoiceTool
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_ToolChoiceAuto",
"properties": {
"type": {
"const": "auto",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceAny",
"properties": {
"type": {
"const": "any",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceTool",
"properties": {
"type": {
"const": "tool",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_ToolChoiceNone",
"properties": {
"type": {
"const": "none",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_ToolChoice3
Complete JSON Schema
Referenced structures: Input_AllowedToolChoice, Input_NamedCustomChoice, Input_NamedFunctionChoice, Input_ToolChoiceMode2
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolChoiceMode2"
},
{
"$ref": "#/components/schemas/Input_NamedFunctionChoice"
},
{
"$ref": "#/components/schemas/Input_NamedCustomChoice"
},
{
"$ref": "#/components/schemas/Input_AllowedToolChoice"
}
]
}Input_ToolChoiceAllowed
Complete JSON Schema
Referenced structures: Input_AllowedToolChoiceMode, Input_ToolChoiceAllowedType
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Input_AllowedToolChoiceMode"
},
"tools": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceAllowedType"
}
},
"required": [
"type",
"mode",
"tools"
],
"type": "object"
}Input_ToolChoiceAllowedType
Complete JSON Schema
{
"enum": [
"allowed_tools"
],
"type": "string"
}Input_ToolChoiceAny
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"disable_parallel_tool_use": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_ToolChoiceApplyPatch
Complete JSON Schema
Referenced structures: Input_ToolChoiceApplyPatchType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceApplyPatchType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ToolChoiceApplyPatchType
Complete JSON Schema
{
"enum": [
"apply_patch"
],
"type": "string"
}Input_ToolChoiceAuto
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"disable_parallel_tool_use": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_ToolChoiceCustom
Complete JSON Schema
Referenced structures: Input_ToolChoiceCustomType
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceCustomType"
}
},
"required": [
"type",
"name"
],
"type": "object"
}Input_ToolChoiceCustomType
Complete JSON Schema
{
"enum": [
"custom"
],
"type": "string"
}Input_ToolChoiceFunction
Complete JSON Schema
Referenced structures: Input_ToolChoiceFunctionType
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceFunctionType"
}
},
"required": [
"type",
"name"
],
"type": "object"
}Input_ToolChoiceFunction2
Complete JSON Schema
Referenced structures: Input_ToolChoiceFunctionType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/tool_choice_function.py`, `ToolChoiceFunction`.",
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceFunctionType2"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_ToolChoiceFunctionType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Input_ToolChoiceFunctionType2
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Input_ToolChoiceHosted
Complete JSON Schema
Referenced structures: Input_ToolChoiceHostedType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceHostedType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ToolChoiceHostedType
Complete JSON Schema
{
"enum": [
"file_search",
"web_search_preview",
"computer",
"computer_use_preview",
"computer_use",
"code_interpreter",
"image_generation",
"web_search_preview_2025_03_11"
],
"type": "string"
}Input_ToolChoiceMcp
Complete JSON Schema
Referenced structures: Input_ToolChoiceMcpType
{
"additionalProperties": true,
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceMcpType"
}
},
"required": [
"type",
"server_label"
],
"type": "object"
}Input_ToolChoiceMcp2
Complete JSON Schema
Referenced structures: Input_ToolChoiceMcpType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/tool_choice_mcp.py`, `ToolChoiceMcp`.",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceMcpType2"
}
},
"required": [
"server_label",
"type"
],
"type": "object"
}Input_ToolChoiceMcpType
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Input_ToolChoiceMcpType2
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Input_ToolChoiceMode
Complete JSON Schema
{
"enum": [
"none",
"auto",
"required"
],
"type": "string"
}Input_ToolChoiceMode2
Complete JSON Schema
{
"enum": [
"none",
"auto",
"required"
],
"type": "string"
}Input_ToolChoiceNone
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ToolChoiceOptions
Complete JSON Schema
{
"description": "Source: `openai/types/responses/tool_choice_options.py`, `ToolChoiceOptions`.",
"enum": [
"none",
"auto",
"required"
],
"type": "string"
}Input_ToolChoiceProgrammatic
Complete JSON Schema
Referenced structures: Input_ToolChoiceProgrammaticType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceProgrammaticType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ToolChoiceProgrammaticType
Complete JSON Schema
{
"enum": [
"programmatic_tool_calling"
],
"type": "string"
}Input_ToolChoiceShell
Complete JSON Schema
Referenced structures: Input_ToolChoiceShellType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_ToolChoiceShellType"
}
},
"required": [
"type"
],
"type": "object"
}Input_ToolChoiceShellType
Complete JSON Schema
{
"enum": [
"shell"
],
"type": "string"
}Input_ToolChoiceTool
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"disable_parallel_tool_use": {
"type": [
"boolean",
"null"
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Input_ToolConfig
Complete JSON Schema
Referenced structures: Input_FunctionCallingConfig, Input_RetrievalConfig
{
"additionalProperties": true,
"properties": {
"functionCallingConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FunctionCallingConfig"
},
{
"type": "null"
}
]
},
"includeServerSideToolInvocations": {
"type": [
"boolean",
"null"
]
},
"retrievalConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_RetrievalConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_ToolDefinition
Complete JSON Schema
Referenced structures: Input_ToolDefinitionType, Input_ToolUnion
{
"additionalProperties": true,
"properties": {
"definition": {
"$ref": "#/components/schemas/Input_ToolUnion"
},
"type": {
"$ref": "#/components/schemas/Input_ToolDefinitionType"
}
},
"required": [
"type",
"definition"
],
"type": "object"
}Input_ToolDefinitionType
Complete JSON Schema
{
"enum": [
"tool_definition"
],
"type": "string"
}Input_ToolExecution
Complete JSON Schema
{
"enum": [
"server",
"client"
],
"type": "string"
}Input_ToolMarker
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_ToolMessage
Complete JSON Schema
Referenced structures: Input_StringOrTextParts, Input_ToolRole
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_StringOrTextParts"
},
"role": {
"$ref": "#/components/schemas/Input_ToolRole"
},
"tool_call_id": {
"type": "string"
}
},
"required": [
"role",
"content",
"tool_call_id"
],
"type": "object"
}Input_ToolReference
Complete JSON Schema
Referenced structures: Input_ToolReferenceType
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolReferenceType"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_ToolReferenceBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ToolReferenceBlockType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"tool_name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolReferenceBlockType"
}
},
"required": [
"type",
"tool_name"
],
"type": "object"
}Input_ToolReferenceBlockType
Complete JSON Schema
{
"enum": [
"tool_reference"
],
"type": "string"
}Input_ToolReferenceType
Complete JSON Schema
{
"enum": [
"tool_reference"
],
"type": "string"
}Input_ToolRemovalBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ToolChangeReference, Input_ToolRemovalType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"tool": {
"$ref": "#/components/schemas/Input_ToolChangeReference"
},
"type": {
"$ref": "#/components/schemas/Input_ToolRemovalType"
}
},
"required": [
"type",
"tool"
],
"type": "object"
}Input_ToolRemovalType
Complete JSON Schema
{
"enum": [
"tool_removal"
],
"type": "string"
}Input_ToolResponse
Complete JSON Schema
Referenced structures: Input_ToolType2
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"response": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"toolType": {
"$ref": "#/components/schemas/Input_ToolType2"
}
},
"required": [
"toolType"
],
"type": "object"
}Input_ToolResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ToolResultBlockType, Input_ToolResultContent
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolResultContent"
},
{
"type": "null"
}
]
},
"is_error": {
"type": [
"boolean",
"null"
]
},
"tool_use_id": {
"type": "string"
},
"toolset_name": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ToolResultBlockType"
}
},
"required": [
"type",
"tool_use_id"
],
"type": "object"
}Input_ToolResultBlockType
Complete JSON Schema
{
"enum": [
"tool_result"
],
"type": "string"
}Input_ToolResultContent
Complete JSON Schema
Referenced structures: Input_ToolResultContentBlock
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_ToolResultContentBlock"
},
"type": "array"
}
]
}Input_ToolResultContentBlock
Complete JSON Schema
Referenced structures: Input_BrowserStateBlock, Input_DocumentBlock, Input_ImageBlock, Input_SearchResultBlock, Input_TextBlock, Input_ToolReferenceBlock
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_BrowserStateBlock"
},
{
"$ref": "#/components/schemas/Input_TextBlock"
},
{
"$ref": "#/components/schemas/Input_ImageBlock"
},
{
"$ref": "#/components/schemas/Input_SearchResultBlock"
},
{
"$ref": "#/components/schemas/Input_DocumentBlock"
},
{
"$ref": "#/components/schemas/Input_ToolReferenceBlock"
}
]
}Input_ToolResultSource
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"id"
],
"type": "object"
}Input_ToolResultSources
Complete JSON Schema
Referenced structures: Input_ParseFailed, Input_ToolResultSource
{
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Input_ToolResultSource"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Input_ParseFailed"
}
]
}Input_ToolRole
Complete JSON Schema
{
"enum": [
"tool"
],
"type": "string"
}Input_ToolSearchBm25Tool20251119
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_ToolSearchBm25Tool20251119Name, Input_ToolSearchBm25Tool20251119Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_ToolSearchBm25Tool20251119Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ToolSearchBm25Tool20251119Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_ToolSearchBm25Tool20251119Name
Complete JSON Schema
{
"enum": [
"tool_search_tool_bm25"
],
"type": "string"
}Input_ToolSearchBm25Tool20251119Type
Complete JSON Schema
{
"enum": [
"tool_search_tool_bm25_20251119",
"tool_search_tool_bm25"
],
"type": "string"
}Input_ToolSearchCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_ItemStatus, Input_ToolExecution, Input_ToolSearchCallType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"arguments": true,
"call_id": {
"type": [
"string",
"null"
]
},
"execution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolExecution"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Input_ToolSearchCallType"
}
},
"required": [
"type",
"arguments"
],
"type": "object"
}Input_ToolSearchCallType
Complete JSON Schema
{
"enum": [
"tool_search_call"
],
"type": "string"
}Input_ToolSearchError
Complete JSON Schema
Referenced structures: Input_ToolSearchErrorCode, Input_ToolSearchErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Input_ToolSearchErrorCode"
},
"error_message": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ToolSearchErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Input_ToolSearchErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded"
],
"type": "string"
}Input_ToolSearchErrorType
Complete JSON Schema
{
"enum": [
"tool_search_tool_result_error"
],
"type": "string"
}Input_ToolSearchOutput
Complete JSON Schema
Referenced structures: Input_Agent, Input_ItemStatus, Input_Tool, Input_ToolExecution, Input_ToolSearchOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": [
"string",
"null"
]
},
"execution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolExecution"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ItemStatus"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Input_Tool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_ToolSearchOutputType"
}
},
"required": [
"type",
"tools"
],
"type": "object"
}Input_ToolSearchOutputType
Complete JSON Schema
{
"enum": [
"tool_search_output"
],
"type": "string"
}Input_ToolSearchRegexTool20251119
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_ToolSearchRegexTool20251119Name, Input_ToolSearchRegexTool20251119Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_ToolSearchRegexTool20251119Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ToolSearchRegexTool20251119Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_ToolSearchRegexTool20251119Name
Complete JSON Schema
{
"enum": [
"tool_search_tool_regex"
],
"type": "string"
}Input_ToolSearchRegexTool20251119Type
Complete JSON Schema
{
"enum": [
"tool_search_tool_regex_20251119",
"tool_search_tool_regex"
],
"type": "string"
}Input_ToolSearchResultContent
Complete JSON Schema
Referenced structures: Input_ToolSearchError, Input_ToolSearchResults
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolSearchError"
},
{
"$ref": "#/components/schemas/Input_ToolSearchResults"
}
]
}Input_ToolSearchResults
Complete JSON Schema
Referenced structures: Input_ToolReferenceBlock, Input_ToolSearchResultsType
{
"additionalProperties": true,
"properties": {
"tool_references": {
"items": {
"$ref": "#/components/schemas/Input_ToolReferenceBlock"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Input_ToolSearchResultsType"
}
},
"required": [
"type",
"tool_references"
],
"type": "object"
}Input_ToolSearchResultsType
Complete JSON Schema
{
"enum": [
"tool_search_tool_search_result"
],
"type": "string"
}Input_ToolSearchTool
Complete JSON Schema
Referenced structures: Input_ToolExecution
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"execution": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ToolExecution"
},
{
"type": "null"
}
]
},
"parameters": true
},
"type": "object"
}Input_ToolSearchToolResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_ToolSearchResultContent, Input_ToolSearchToolResultType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_ToolSearchResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_ToolSearchToolResultType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Input_ToolSearchToolResultType
Complete JSON Schema
{
"enum": [
"tool_search_tool_result"
],
"type": "string"
}Input_ToolType
Complete JSON Schema
{
"enum": [
"custom"
],
"type": "string"
}Input_ToolType2
Complete JSON Schema
{
"enum": [
"TOOL_TYPE_UNSPECIFIED",
"GOOGLE_SEARCH_WEB",
"GOOGLE_SEARCH_IMAGE",
"URL_CONTEXT",
"GOOGLE_MAPS",
"FILE_SEARCH"
],
"type": "string"
}Input_ToolUnion
Complete JSON Schema
Referenced structures: Input_AdvisorTool20260301, Input_BashTool20241022, Input_BashTool20250124, Input_BrowserToolset20260801, Input_CodeExecutionTool20250522, Input_CodeExecutionTool20250825, Input_CodeExecutionTool20260120, Input_CodeExecutionTool20260521, Input_ComputerTool20241022, Input_ComputerTool20250124, Input_ComputerTool20251124, Input_ComputerToolset20260801, Input_McpToolset, Input_MemoryTool20250818, Input_TextEditorTool20241022, Input_TextEditorTool20250124, Input_TextEditorTool20250429, Input_TextEditorTool20250728, Input_Tool2, Input_ToolSearchBm25Tool20251119, Input_ToolSearchRegexTool20251119, Input_WebFetchTool20250910, Input_WebFetchTool20260209, Input_WebFetchTool20260309, Input_WebFetchTool20260318, Input_WebSearchTool20250305, Input_WebSearchTool20260209, Input_WebSearchTool20260318
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_BrowserToolset20260801"
},
{
"$ref": "#/components/schemas/Input_ComputerToolset20260801"
},
{
"$ref": "#/components/schemas/Input_Tool2"
},
{
"$ref": "#/components/schemas/Input_McpToolset"
},
{
"$ref": "#/components/schemas/Input_BashTool20241022"
},
{
"$ref": "#/components/schemas/Input_BashTool20250124"
},
{
"$ref": "#/components/schemas/Input_CodeExecutionTool20250522"
},
{
"$ref": "#/components/schemas/Input_CodeExecutionTool20250825"
},
{
"$ref": "#/components/schemas/Input_CodeExecutionTool20260120"
},
{
"$ref": "#/components/schemas/Input_CodeExecutionTool20260521"
},
{
"$ref": "#/components/schemas/Input_ComputerTool20241022"
},
{
"$ref": "#/components/schemas/Input_MemoryTool20250818"
},
{
"$ref": "#/components/schemas/Input_ComputerTool20250124"
},
{
"$ref": "#/components/schemas/Input_TextEditorTool20241022"
},
{
"$ref": "#/components/schemas/Input_ComputerTool20251124"
},
{
"$ref": "#/components/schemas/Input_TextEditorTool20250124"
},
{
"$ref": "#/components/schemas/Input_TextEditorTool20250429"
},
{
"$ref": "#/components/schemas/Input_TextEditorTool20250728"
},
{
"$ref": "#/components/schemas/Input_WebSearchTool20250305"
},
{
"$ref": "#/components/schemas/Input_WebFetchTool20250910"
},
{
"$ref": "#/components/schemas/Input_WebSearchTool20260209"
},
{
"$ref": "#/components/schemas/Input_WebFetchTool20260209"
},
{
"$ref": "#/components/schemas/Input_WebFetchTool20260309"
},
{
"$ref": "#/components/schemas/Input_WebSearchTool20260318"
},
{
"$ref": "#/components/schemas/Input_WebFetchTool20260318"
},
{
"$ref": "#/components/schemas/Input_AdvisorTool20260301"
},
{
"$ref": "#/components/schemas/Input_ToolSearchBm25Tool20251119"
},
{
"$ref": "#/components/schemas/Input_ToolSearchRegexTool20251119"
}
]
}Input_ToolUseBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_Caller2, Input_ToolUseBlockType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller2"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input": true,
"name": {
"type": "string"
},
"toolset_name": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_ToolUseBlockType"
}
},
"required": [
"type",
"id",
"input",
"name"
],
"type": "object"
}Input_ToolUseBlockType
Complete JSON Schema
{
"enum": [
"tool_use"
],
"type": "string"
}Input_ToolUsesKeep
Complete JSON Schema
Referenced structures: Input_ToolUsesType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_ToolUsesType"
},
"value": {
"format": "int64",
"type": "integer"
}
},
"required": [
"type",
"value"
],
"type": "object"
}Input_ToolUsesType
Complete JSON Schema
{
"enum": [
"tool_uses"
],
"type": "string"
}Input_ToolsetMemberConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"enabled": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Input_TopLogprob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"logprob": {
"type": "number"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"bytes",
"logprob"
],
"type": "object"
}Input_TranscriptionInclude
Complete JSON Schema
{
"enum": [
"logprobs"
],
"type": "string"
}Input_TranscriptionResponseFormat
Complete JSON Schema
{
"enum": [
"json",
"text",
"srt",
"verbose_json",
"vtt",
"diarized_json"
],
"type": "string"
}Input_TranscriptionTimestampGranularity
Complete JSON Schema
{
"enum": [
"word",
"segment"
],
"type": "string"
}Input_TranslationConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"echoTargetLanguage": {
"type": [
"boolean",
"null"
]
},
"targetLanguageCode": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_TranslationResponseFormat
Complete JSON Schema
{
"enum": [
"json",
"text",
"srt",
"verbose_json",
"vtt"
],
"type": "string"
}Input_Truncation
Complete JSON Schema
{
"enum": [
"auto",
"disabled"
],
"type": "string"
}Input_TurnCoverage
Complete JSON Schema
{
"enum": [
"TURN_COVERAGE_UNSPECIFIED",
"TURN_INCLUDES_ONLY_ACTIVITY",
"TURN_INCLUDES_ALL_INPUT",
"TURN_INCLUDES_AUDIO_ACTIVITY_AND_ALL_VIDEO"
],
"type": "string"
}Input_TypeAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Input_UploadFileForm
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_FileExpiry, Input_UploadFilePurpose
{
"properties": {
"expires_after": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_FileExpiry"
},
{
"type": "null"
}
]
},
"file": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"purpose": {
"$ref": "#/components/schemas/Input_UploadFilePurpose"
}
},
"required": [
"file",
"purpose"
],
"type": "object"
}Input_UploadFileForm2
Complete JSON Schema
Referenced structures: Input_BinaryPart
{
"properties": {
"expires_in_seconds": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"file": {
"$ref": "#/components/schemas/Input_BinaryPart"
}
},
"required": [
"file"
],
"type": "object"
}Input_UploadFileForm3
Complete JSON Schema
Referenced structures: Input_BinaryPart, Input_UploadFileMetadata
{
"properties": {
"file": {
"$ref": "#/components/schemas/Input_BinaryPart"
},
"metadata": {
"$ref": "#/components/schemas/Input_UploadFileMetadata"
}
},
"required": [
"file",
"metadata"
],
"type": "object"
}Input_UploadFileMetadata
Complete JSON Schema
Referenced structures: Input_File
{
"additionalProperties": true,
"properties": {
"file": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_File"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_UploadFilePurpose
Complete JSON Schema
{
"enum": [
"assistants",
"batch",
"fine-tune",
"vision",
"user_data",
"evals"
],
"type": "string"
}Input_UrlCitation
Complete JSON Schema
Referenced structures: Input_UrlCitationType
{
"additionalProperties": true,
"properties": {
"end_index": {
"format": "int64",
"type": "integer"
},
"start_index": {
"format": "int64",
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_UrlCitationType"
},
"url": {
"type": "string"
}
},
"required": [
"end_index",
"start_index",
"title",
"url",
"type"
],
"type": "object"
}Input_UrlCitationType
Complete JSON Schema
{
"enum": [
"url_citation"
],
"type": "string"
}Input_UrlContext
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_UrlSource
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}Input_UsageGroupBy
Complete JSON Schema
{
"description": "Which column the aggregate is cut by.",
"oneOf": [
{
"enum": [
"user",
"apiKey",
"operation"
],
"type": "string"
},
{
"const": "model",
"description": "The upstream model name stored on the usage row.",
"type": "string"
},
{
"const": "provider",
"description": "Group structured upstream usage by provider, with each provider's own quantities and cost.",
"type": "string"
},
{
"const": "credential",
"description": "The same per-attempt cut as `Provider`, keyed by the credential that\nserved each attempt: what each upstream account actually spent.",
"type": "string"
}
]
}Input_UserContentPart
Complete JSON Schema
Referenced structures: Input_FilePart, Input_ImagePart, Input_InputAudioPart, Input_TextPart
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_TextPart"
},
{
"$ref": "#/components/schemas/Input_ImagePart"
},
{
"$ref": "#/components/schemas/Input_InputAudioPart"
},
{
"$ref": "#/components/schemas/Input_FilePart"
}
]
}Input_UserContentParts
Complete JSON Schema
Referenced structures: Input_UserContentPart
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Input_UserContentPart"
},
"type": "array"
}
]
}Input_UserLocation
Complete JSON Schema
Referenced structures: Input_UserLocationType
{
"additionalProperties": true,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"region": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_UserLocationType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_UserLocation2
Complete JSON Schema
Referenced structures: Input_UserLocationType2
{
"additionalProperties": true,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"region": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_UserLocationType2"
}
},
"required": [
"type"
],
"type": "object"
}Input_UserLocation3
Complete JSON Schema
Referenced structures: Input_ApproximateLocation, Input_UserLocationType3
{
"additionalProperties": true,
"properties": {
"approximate": {
"$ref": "#/components/schemas/Input_ApproximateLocation"
},
"type": {
"$ref": "#/components/schemas/Input_UserLocationType3"
}
},
"required": [
"type",
"approximate"
],
"type": "object"
}Input_UserLocationType
Complete JSON Schema
{
"enum": [
"approximate"
],
"type": "string"
}Input_UserLocationType2
Complete JSON Schema
{
"enum": [
"approximate"
],
"type": "string"
}Input_UserLocationType3
Complete JSON Schema
{
"enum": [
"approximate"
],
"type": "string"
}Input_UserMessage
Complete JSON Schema
Referenced structures: Input_UserContentParts, Input_UserRole
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_UserContentParts"
},
"name": {
"type": [
"string",
"null"
]
},
"role": {
"$ref": "#/components/schemas/Input_UserRole"
}
},
"required": [
"role",
"content"
],
"type": "object"
}Input_UserPatch
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"name": {
"default": null,
"type": [
"string",
"null"
]
},
"oauthClientAllowlist": {
"default": null,
"description": "Absent leaves the allowlist alone, `null` clears it back to inheriting,\na list replaces it. The password is deliberately not patchable here:\nchanging one revokes sessions, so it is its own operation.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"role": {
"default": null,
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_UserRole
Complete JSON Schema
{
"enum": [
"user"
],
"type": "string"
}Input_UserWrite
Complete JSON Schema
{
"properties": {
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"oauthClientAllowlist": {
"default": null,
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"password": {
"default": null,
"description": "Optional: a user created without one cannot sign in until a password is\nset, which is what an API-key-only account is.",
"type": [
"string",
"null"
]
},
"role": {
"default": null,
"description": "`admin` or `user`; absent means `user`.",
"type": [
"string",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Input_VadConfig
Complete JSON Schema
Referenced structures: Input_VadType
{
"additionalProperties": true,
"properties": {
"prefix_padding_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silence_duration_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_VadType"
}
},
"required": [
"type"
],
"type": "object"
}Input_VadType
Complete JSON Schema
{
"enum": [
"server_vad"
],
"type": "string"
}Input_Verbosity
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
}Input_VideoFileMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"videoDuration": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_VideoMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endOffset": {
"type": [
"string",
"null"
]
},
"fps": {
"format": "double",
"type": [
"number",
"null"
]
},
"startOffset": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_VoiceConfig
Complete JSON Schema
Referenced structures: Input_PrebuiltVoiceConfig
{
"additionalProperties": true,
"properties": {
"prebuiltVoiceConfig": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PrebuiltVoiceConfig"
},
{
"type": "null"
}
]
},
"voice": {
"description": "Prebuilt speaker name, stored `voice_...` ID, or client-managed `voicekey_...`.",
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_VoiceConsentSignature
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"signature": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_VoiceSource
Complete JSON Schema
{
"enum": [
"prompt",
"audio_sample"
],
"type": "string"
}Input_WaitAction
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_WeatherOperation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"duration": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"location": {
"type": "string"
},
"start": {
"type": [
"string",
"null"
]
}
},
"required": [
"location"
],
"type": "object"
}Input_WebCitation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"encrypted_index": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"cited_text",
"encrypted_index",
"title",
"url"
],
"type": "object"
}Input_WebFetchError
Complete JSON Schema
Referenced structures: Input_WebFetchErrorCode, Input_WebFetchErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Input_WebFetchErrorCode"
},
"type": {
"$ref": "#/components/schemas/Input_WebFetchErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Input_WebFetchErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"url_too_long",
"url_not_allowed",
"url_not_in_prior_context",
"url_not_accessible",
"unsupported_content_type",
"too_many_requests",
"max_uses_exceeded",
"unavailable"
],
"type": "string"
}Input_WebFetchErrorType
Complete JSON Schema
{
"enum": [
"web_fetch_tool_result_error"
],
"type": "string"
}Input_WebFetchResult
Complete JSON Schema
Referenced structures: Input_DocumentBlock, Input_WebFetchResultType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Input_DocumentBlock"
},
"retrieved_at": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebFetchResultType"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"content",
"url"
],
"type": "object"
}Input_WebFetchResultContent
Complete JSON Schema
Referenced structures: Input_WebFetchError, Input_WebFetchResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Input_WebFetchError"
},
{
"$ref": "#/components/schemas/Input_WebFetchResult"
}
]
}Input_WebFetchResultType
Complete JSON Schema
{
"enum": [
"web_fetch_result"
],
"type": "string"
}Input_WebFetchTool20250910
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CitationsConfig, Input_WebFetchTool20250910Name, Input_WebFetchTool20250910Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"citations": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CitationsConfig"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_content_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_WebFetchTool20250910Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebFetchTool20250910Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_WebFetchTool20250910Name
Complete JSON Schema
{
"enum": [
"web_fetch"
],
"type": "string"
}Input_WebFetchTool20250910Type
Complete JSON Schema
{
"enum": [
"web_fetch_20250910"
],
"type": "string"
}Input_WebFetchTool20260209
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CitationsConfig, Input_WebFetchTool20260209Name, Input_WebFetchTool20260209Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"citations": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CitationsConfig"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_content_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_WebFetchTool20260209Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebFetchTool20260209Type"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_WebFetchTool20260209Name
Complete JSON Schema
{
"enum": [
"web_fetch"
],
"type": "string"
}Input_WebFetchTool20260209Type
Complete JSON Schema
{
"enum": [
"web_fetch_20260209"
],
"type": "string"
}Input_WebFetchTool20260309
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CitationsConfig, Input_WebFetchTool20260309Name, Input_WebFetchTool20260309Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"citations": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CitationsConfig"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_content_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_WebFetchTool20260309Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebFetchTool20260309Type"
},
"use_cache": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_WebFetchTool20260309Name
Complete JSON Schema
{
"enum": [
"web_fetch"
],
"type": "string"
}Input_WebFetchTool20260309Type
Complete JSON Schema
{
"enum": [
"web_fetch_20260309"
],
"type": "string"
}Input_WebFetchTool20260318
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_CitationsConfig, Input_ResponseInclusion, Input_WebFetchTool20260318Name, Input_WebFetchTool20260318Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"citations": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CitationsConfig"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_content_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_WebFetchTool20260318Name"
},
"response_inclusion": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInclusion"
},
{
"type": "null"
}
]
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebFetchTool20260318Type"
},
"use_cache": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_WebFetchTool20260318Name
Complete JSON Schema
{
"enum": [
"web_fetch"
],
"type": "string"
}Input_WebFetchTool20260318Type
Complete JSON Schema
{
"enum": [
"web_fetch_20260318"
],
"type": "string"
}Input_WebFetchToolResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_Caller2, Input_WebFetchResultContent, Input_WebFetchToolResultType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller2"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_WebFetchResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_WebFetchToolResultType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Input_WebFetchToolResultType
Complete JSON Schema
{
"enum": [
"web_fetch_tool_result"
],
"type": "string"
}Input_WebSearch
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_WebSearchAction
Complete JSON Schema
Referenced structures: Input_WebSearchFindInPage, Input_WebSearchOpenPage, Input_WebSearchQuery
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_WebSearchQuery",
"properties": {
"type": {
"const": "search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchOpenPage",
"properties": {
"type": {
"const": "open_page",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchFindInPage",
"properties": {
"type": {
"const": "find_in_page",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_WebSearchAction2
Complete JSON Schema
Referenced structures: Input_WebSearchActionFindInPage, Input_WebSearchActionOpenPage, Input_WebSearchActionOther, Input_WebSearchActionSearch
{
"oneOf": [
{
"$ref": "#/components/schemas/Input_WebSearchActionSearch",
"properties": {
"type": {
"const": "search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchActionOpenPage",
"properties": {
"type": {
"const": "open_page",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchActionFindInPage",
"properties": {
"type": {
"const": "find_in_page",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Input_WebSearchActionOther",
"properties": {
"type": {
"const": "other",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Input_WebSearchActionFindInPage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"pattern": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_WebSearchActionOpenPage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_WebSearchActionOther
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Input_WebSearchActionSearch
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"queries": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"query": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_WebSearchCall
Complete JSON Schema
Referenced structures: Input_Agent, Input_WebSearchAction, Input_WebSearchCallType, Input_WebSearchStatus
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_WebSearchAction"
},
{
"type": "null"
}
],
"description": "The initial in-progress stream item precedes its search action."
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Input_WebSearchStatus"
},
"type": {
"$ref": "#/components/schemas/Input_WebSearchCallType"
}
},
"required": [
"type",
"id",
"status"
],
"type": "object"
}Input_WebSearchCallType
Complete JSON Schema
{
"enum": [
"web_search_call"
],
"type": "string"
}Input_WebSearchError
Complete JSON Schema
Referenced structures: Input_WebSearchErrorCode, Input_WebSearchErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Input_WebSearchErrorCode"
},
"type": {
"$ref": "#/components/schemas/Input_WebSearchErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Input_WebSearchErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"max_uses_exceeded",
"too_many_requests",
"query_too_long",
"request_too_large"
],
"type": "string"
}Input_WebSearchErrorType
Complete JSON Schema
{
"enum": [
"web_search_tool_result_error"
],
"type": "string"
}Input_WebSearchFilters
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_WebSearchFindInPage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"pattern": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"pattern"
],
"type": "object"
}Input_WebSearchOpenPage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_WebSearchOptions
Complete JSON Schema
Referenced structures: Input_SearchContextSize2, Input_UserLocation3
{
"additionalProperties": true,
"properties": {
"search_context_size": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchContextSize2"
},
{
"type": "null"
}
]
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_UserLocation3"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_WebSearchPreviewTool
Complete JSON Schema
Referenced structures: Input_PreviewUserLocation, Input_SearchContentType, Input_SearchContextSize
{
"additionalProperties": true,
"properties": {
"search_content_types": {
"items": {
"$ref": "#/components/schemas/Input_SearchContentType"
},
"type": [
"array",
"null"
]
},
"search_context_size": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchContextSize"
},
{
"type": "null"
}
]
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_PreviewUserLocation"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_WebSearchQuery
Complete JSON Schema
Referenced structures: Input_WebSearchSource
{
"additionalProperties": true,
"properties": {
"queries": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"query": {
"type": [
"string",
"null"
]
},
"sources": {
"items": {
"$ref": "#/components/schemas/Input_WebSearchSource"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Input_WebSearchRequestBody
Complete JSON Schema
Referenced structures: Input_Reasoning, Input_SearchCommands, Input_SearchInput, Input_SearchSettings
{
"additionalProperties": true,
"properties": {
"commands": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchCommands"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchInput"
},
{
"type": "null"
}
]
},
"max_output_tokens": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"model": {
"type": "string"
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Reasoning"
},
{
"type": "null"
}
]
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchSettings"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"model"
],
"type": "object"
}Input_WebSearchResult
Complete JSON Schema
Referenced structures: Input_WebSearchResultType
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
},
"page_age": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_WebSearchResultType"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"encrypted_content",
"title",
"url"
],
"type": "object"
}Input_WebSearchResultContent
Complete JSON Schema
Referenced structures: Input_WebSearchError, Input_WebSearchResult
{
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/Input_WebSearchResult"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Input_WebSearchError"
}
]
}Input_WebSearchResultType
Complete JSON Schema
{
"enum": [
"web_search_result"
],
"type": "string"
}Input_WebSearchSource
Complete JSON Schema
Referenced structures: Input_WebSearchSourceType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Input_WebSearchSourceType"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}Input_WebSearchSourceType
Complete JSON Schema
{
"enum": [
"url"
],
"type": "string"
}Input_WebSearchStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"searching",
"completed",
"failed",
"incomplete"
],
"type": "string"
}Input_WebSearchTool
Complete JSON Schema
Referenced structures: Input_SearchContextSize, Input_UserLocation, Input_WebSearchFilters
{
"additionalProperties": true,
"properties": {
"filters": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_WebSearchFilters"
},
{
"type": "null"
}
]
},
"search_context_size": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_SearchContextSize"
},
{
"type": "null"
}
]
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_UserLocation"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Input_WebSearchTool20250305
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_UserLocation2, Input_WebSearchTool20250305Name, Input_WebSearchTool20250305Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_WebSearchTool20250305Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebSearchTool20250305Type"
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_UserLocation2"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_WebSearchTool20250305Name
Complete JSON Schema
{
"enum": [
"web_search"
],
"type": "string"
}Input_WebSearchTool20250305Type
Complete JSON Schema
{
"enum": [
"web_search_20250305"
],
"type": "string"
}Input_WebSearchTool20260209
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_UserLocation2, Input_WebSearchTool20260209Name, Input_WebSearchTool20260209Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_WebSearchTool20260209Name"
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebSearchTool20260209Type"
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_UserLocation2"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_WebSearchTool20260209Name
Complete JSON Schema
{
"enum": [
"web_search"
],
"type": "string"
}Input_WebSearchTool20260209Type
Complete JSON Schema
{
"enum": [
"web_search_20260209"
],
"type": "string"
}Input_WebSearchTool20260318
Complete JSON Schema
Referenced structures: Input_AllowedCaller2, Input_CacheControl, Input_ResponseInclusion, Input_UserLocation2, Input_WebSearchTool20260318Name, Input_WebSearchTool20260318Type
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Input_AllowedCaller2"
},
"type": [
"array",
"null"
]
},
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"blocked_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"max_uses": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"$ref": "#/components/schemas/Input_WebSearchTool20260318Name"
},
"response_inclusion": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_ResponseInclusion"
},
{
"type": "null"
}
]
},
"strict": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Input_WebSearchTool20260318Type"
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_UserLocation2"
},
{
"type": "null"
}
]
}
},
"required": [
"name",
"type"
],
"type": "object"
}Input_WebSearchTool20260318Name
Complete JSON Schema
{
"enum": [
"web_search"
],
"type": "string"
}Input_WebSearchTool20260318Type
Complete JSON Schema
{
"enum": [
"web_search_20260318"
],
"type": "string"
}Input_WebSearchToolResultBlock
Complete JSON Schema
Referenced structures: Input_CacheControl, Input_Caller2, Input_WebSearchResultContent, Input_WebSearchToolResultType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_CacheControl"
},
{
"type": "null"
}
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Input_Caller2"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Input_WebSearchResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Input_WebSearchToolResultType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Input_WebSearchToolResultType
Complete JSON Schema
{
"enum": [
"web_search_tool_result"
],
"type": "string"
}Input_WordInfo
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endOffset": {
"type": [
"string",
"null"
]
},
"startOffset": {
"type": [
"string",
"null"
]
},
"word": {
"type": "string"
}
},
"required": [
"word"
],
"type": "object"
}Input_WordInfo2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endOffset": {
"type": [
"string",
"null"
]
},
"startOffset": {
"type": [
"string",
"null"
]
},
"word": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Input_ZipMediaType
Complete JSON Schema
{
"enum": [
"application/zip"
],
"type": "string"
}Output_Action
Complete JSON Schema
{
"enum": [
"spawn_agent",
"interrupt_agent",
"list_agents",
"send_message",
"followup_task",
"wait_agent"
],
"type": "string"
}Output_AdditionalTools
Complete JSON Schema
Referenced structures: Output_AdditionalToolsRole, Output_AdditionalToolsType, Output_Agent, Output_Tool
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"role": {
"$ref": "#/components/schemas/Output_AdditionalToolsRole"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_Tool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_AdditionalToolsType"
}
},
"required": [
"type",
"role",
"tools"
],
"type": "object"
}Output_AdditionalToolsRole
Complete JSON Schema
{
"enum": [
"developer"
],
"type": "string"
}Output_AdditionalToolsType
Complete JSON Schema
{
"enum": [
"additional_tools"
],
"type": "string"
}Output_AdminContextDto
Complete JSON Schema
Referenced structures: Output_AdminContextUserDto, Output_AdminScopeDto, Output_AdminSectionDto
{
"description": "The whole answer.",
"properties": {
"callerKind": {
"description": "`apiKey`, `oauthGrant` or `session`. A console only ever sees\n`session`; a script reading its own context sees which credential it\npresented.",
"type": "string"
},
"scope": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AdminScopeDto"
},
{
"type": "null"
}
],
"description": "What this request is acting as. `null` means the caller administers\nseveral scopes and named none — every other route answers `400` until\none is named."
},
"scopeHeader": {
"description": "The header a session names its scope with, so a console does not have\nto hard-code it.",
"type": "string"
},
"scopes": {
"description": "Every scope this caller may act as. One entry for an instance\nadministrator, one for an API key, one or more for a session.",
"items": {
"$ref": "#/components/schemas/Output_AdminScopeDto"
},
"type": "array"
},
"sections": {
"description": "The sections `scope` reaches, in navigation order. Empty while `scope`\nis `null`.",
"items": {
"$ref": "#/components/schemas/Output_AdminSectionDto"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/Output_AdminContextUserDto"
}
},
"required": [
"user",
"callerKind",
"scopeHeader",
"scope",
"scopes",
"sections"
],
"type": "object"
}Output_AdminContextUserDto
Complete JSON Schema
{
"properties": {
"id": {
"type": "string"
},
"instanceAdmin": {
"type": "boolean"
},
"name": {
"description": "The display name, when this revision's snapshot knows the user. A user\ncreated after the snapshot was taken is still a valid caller, so this\nis optional rather than a reason to fail.",
"type": [
"string",
"null"
]
},
"role": {
"description": "The instance-wide `users.role`. Organization and team roles are\nmemberships and appear as `scopes`, not here.",
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"instanceAdmin"
],
"type": "object"
}Output_AdminScopeDto
Complete JSON Schema
{
"description": "One scope the caller may act as.",
"properties": {
"current": {
"type": "boolean"
},
"id": {
"description": "The organization or team id. `null` for the instance scope.",
"type": [
"string",
"null"
]
},
"kind": {
"description": "`instance`, `organization` or `team`.",
"type": "string"
},
"name": {
"description": "Its display name, when the snapshot knows the row.",
"type": [
"string",
"null"
]
},
"organizationId": {
"description": "For a team, its parent organization; for an organization, itself.",
"type": [
"string",
"null"
]
},
"selector": {
"description": "The exact value to send in the scope header to act as this.",
"type": "string"
}
},
"required": [
"kind",
"id",
"name",
"organizationId",
"selector",
"current"
],
"type": "object"
}Output_AdminSectionDto
Complete JSON Schema
{
"description": "One navigable family, as the console's navigation reads it.",
"properties": {
"capabilities": {
"description": "`read`, `write`, or both.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"path": {
"description": "The collection path under `/admin/api`.",
"type": "string"
}
},
"required": [
"id",
"path",
"capabilities"
],
"type": "object"
}Output_AdvisorError
Complete JSON Schema
Referenced structures: Output_AdvisorErrorCode, Output_AdvisorErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Output_AdvisorErrorCode"
},
"type": {
"$ref": "#/components/schemas/Output_AdvisorErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Output_AdvisorErrorCode
Complete JSON Schema
{
"enum": [
"max_uses_exceeded",
"prompt_too_long",
"too_many_requests",
"overloaded",
"unavailable",
"execution_time_exceeded",
"model_not_found"
],
"type": "string"
}Output_AdvisorErrorType
Complete JSON Schema
{
"enum": [
"advisor_tool_result_error"
],
"type": "string"
}Output_AdvisorMessageIterationUsage
Complete JSON Schema
Referenced structures: Output_AdvisorMessageIterationUsageType, Output_CacheCreation
{
"additionalProperties": true,
"properties": {
"cache_creation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheCreation"
},
{
"type": "null"
}
]
},
"cache_creation_input_tokens": {
"format": "int64",
"type": "integer"
},
"cache_read_input_tokens": {
"format": "int64",
"type": "integer"
},
"input_tokens": {
"format": "int64",
"type": "integer"
},
"model": {
"type": "string"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_AdvisorMessageIterationUsageType"
}
},
"required": [
"type",
"cache_creation_input_tokens",
"cache_read_input_tokens",
"input_tokens",
"model",
"output_tokens"
],
"type": "object"
}Output_AdvisorMessageIterationUsageType
Complete JSON Schema
{
"enum": [
"advisor_message"
],
"type": "string"
}Output_Agent
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"agent_name": {
"type": "string"
}
},
"required": [
"agent_name"
],
"type": "object"
}Output_AgentContent
Complete JSON Schema
Referenced structures: Output_AgentText, Output_ComputerScreenshot, Output_EncryptedContent, Output_ReasoningContent, Output_ReplayOutputText, Output_ResponseInputFile, Output_ResponseInputImage, Output_ResponseInputText, Output_ResponseOutputRefusal, Output_SummaryText
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseInputText"
},
{
"$ref": "#/components/schemas/Output_ReplayOutputText"
},
{
"$ref": "#/components/schemas/Output_AgentText"
},
{
"$ref": "#/components/schemas/Output_SummaryText"
},
{
"$ref": "#/components/schemas/Output_ReasoningContent"
},
{
"$ref": "#/components/schemas/Output_ResponseOutputRefusal"
},
{
"$ref": "#/components/schemas/Output_ResponseInputImage"
},
{
"$ref": "#/components/schemas/Output_ComputerScreenshot"
},
{
"$ref": "#/components/schemas/Output_ResponseInputFile"
},
{
"$ref": "#/components/schemas/Output_EncryptedContent"
}
]
}Output_AgentMessage
Complete JSON Schema
Referenced structures: Output_Agent, Output_AgentContent, Output_AgentMessageType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"author": {
"type": "string"
},
"content": {
"items": {
"$ref": "#/components/schemas/Output_AgentContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"recipient": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_AgentMessageType"
}
},
"required": [
"type",
"author",
"recipient",
"content"
],
"type": "object"
}Output_AgentMessageType
Complete JSON Schema
{
"enum": [
"agent_message"
],
"type": "string"
}Output_AgentText
Complete JSON Schema
Referenced structures: Output_AgentTextType
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_AgentTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_AgentTextType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Output_AllowedCaller
Complete JSON Schema
{
"enum": [
"direct",
"programmatic"
],
"type": "string"
}Output_AllowedToolChoiceMode
Complete JSON Schema
{
"enum": [
"auto",
"required"
],
"type": "string"
}Output_Annotation
Complete JSON Schema
Referenced structures: Output_AnnotationType, Output_UrlCitation2
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_AnnotationType"
},
"url_citation": {
"$ref": "#/components/schemas/Output_UrlCitation2"
}
},
"required": [
"type",
"url_citation"
],
"type": "object"
}Output_AnnotationType
Complete JSON Schema
{
"enum": [
"url_citation"
],
"type": "string"
}Output_Announcement
Complete JSON Schema
Referenced structures: Output_AnnouncementContent, Output_AnnouncementSeverity
{
"description": "One notice from the publisher's feed, already known to apply to this build.",
"properties": {
"affects": {
"description": "The semver range the notice applies to, when it is not for everyone.",
"type": [
"string",
"null"
]
},
"content": {
"additionalProperties": {
"$ref": "#/components/schemas/Output_AnnouncementContent"
},
"description": "Keyed by BCP 47 tag. `en` is always present; a console falls back to it.",
"type": "object"
},
"expires_at": {
"type": [
"string",
"null"
]
},
"id": {
"description": "Stable across edits of the same notice, so a console can remember which\nones a reader has dismissed.",
"type": "string"
},
"published_at": {
"description": "RFC 3339, as published.",
"type": "string"
},
"severity": {
"$ref": "#/components/schemas/Output_AnnouncementSeverity"
}
},
"required": [
"id",
"severity",
"published_at",
"content"
],
"type": "object"
}Output_AnnouncementContent
Complete JSON Schema
{
"description": "A notice in one language. The body is a small Markdown subset — headings,\nblockquotes, bullets, bold and code — which is all the publisher's checker\nadmits and all a console has to render.",
"properties": {
"body": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"title",
"body"
],
"type": "object"
}Output_AnnouncementSeverity
Complete JSON Schema
{
"enum": [
"info",
"warning",
"critical"
],
"type": "string"
}Output_ApiKeyCreated
Complete JSON Schema
{
"description": "A minted or rotated key. `token` is the only time the plaintext exists in\na response; a caller that loses it rotates the key, it is not recoverable\nunless the row was created with `retainSecret`.",
"properties": {
"enabled": {
"type": "boolean"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"hasSecret": {
"description": "Whether the instance retained a sealed copy of the key text, i.e.\nwhether `reveal` can answer. The bytes themselves have no field.",
"type": "boolean"
},
"id": {
"type": "string"
},
"kind": {
"description": "`user` or `oauth`. An `oauth` key is a grant's internal key and is not\na bearer credential; it is listed so an operator can see it, never\ncreated or revealed through this family.",
"type": "string"
},
"management": {
"description": "Whether the key may manage; see `api_keys.management`.",
"type": "boolean"
},
"name": {
"type": "string"
},
"organizationId": {
"type": [
"string",
"null"
]
},
"prefix": {
"description": "The first eight characters of the key body, for recognising a key in a\nlist. Not a secret and not enough of one to be useful.",
"type": "string"
},
"teamId": {
"type": [
"string",
"null"
]
},
"token": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"id",
"userId",
"name",
"prefix",
"kind",
"organizationId",
"teamId",
"expiresAtMs",
"enabled",
"management",
"hasSecret",
"token"
],
"type": "object"
}Output_ApiKeyDto
Complete JSON Schema
{
"properties": {
"enabled": {
"type": "boolean"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"hasSecret": {
"description": "Whether the instance retained a sealed copy of the key text, i.e.\nwhether `reveal` can answer. The bytes themselves have no field.",
"type": "boolean"
},
"id": {
"type": "string"
},
"kind": {
"description": "`user` or `oauth`. An `oauth` key is a grant's internal key and is not\na bearer credential; it is listed so an operator can see it, never\ncreated or revealed through this family.",
"type": "string"
},
"management": {
"description": "Whether the key may manage; see `api_keys.management`.",
"type": "boolean"
},
"name": {
"type": "string"
},
"organizationId": {
"type": [
"string",
"null"
]
},
"prefix": {
"description": "The first eight characters of the key body, for recognising a key in a\nlist. Not a secret and not enough of one to be useful.",
"type": "string"
},
"teamId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": "string"
}
},
"required": [
"id",
"userId",
"name",
"prefix",
"kind",
"organizationId",
"teamId",
"expiresAtMs",
"enabled",
"management",
"hasSecret"
],
"type": "object"
}Output_ApiKeySecretDto
Complete JSON Schema
{
"description": "The answer to `reveal`, for a key whose secret the instance was asked to\nretain. Separate from [`ApiKeyDto`] so a plaintext can never ride along\nwith an ordinary read.",
"properties": {
"id": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"id",
"token"
],
"type": "object"
}Output_AppliedUpdate
Complete JSON Schema
{
"description": "The answer to an apply or a rollback.",
"properties": {
"changed": {
"description": "Whether anything was actually replaced. `false` means the instance was\nalready on that version and nothing was written.",
"type": "boolean"
},
"restart": {
"description": "What is about to happen to the process.",
"type": "string"
},
"version": {
"description": "The version now on disk.\n\n`None` after a **rollback**: the executable that was put back carries\nits own version and nothing on disk records what it was. Reporting the\ncalling process's version instead would be a guess that is wrong in\nexactly the common case — a console pressing rollback is talking to the\nbinary that was installed.",
"type": [
"string",
"null"
]
}
},
"required": [
"version",
"changed",
"restart"
],
"type": "object"
}Output_ApplyDefaultPricesReportDto
Complete JSON Schema
{
"properties": {
"created": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"skipped": {
"description": "Rules already present that `overwrite: false` left alone.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"unmatched": {
"description": "Names no catalog entry covers.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"updated": {
"description": "Rules `overwrite` replaced, rates and tiers included.",
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"created",
"updated",
"skipped",
"unmatched"
],
"type": "object"
}Output_ApplyPatchCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_ApplyPatchCallType, Output_ApplyPatchOperation, Output_ApplyPatchStatus, Output_Caller
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"operation": {
"$ref": "#/components/schemas/Output_ApplyPatchOperation"
},
"status": {
"$ref": "#/components/schemas/Output_ApplyPatchStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ApplyPatchCallType"
}
},
"required": [
"type",
"call_id",
"operation",
"status"
],
"type": "object"
}Output_ApplyPatchCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ApplyPatchCallOutputType, Output_ApplyPatchOutputStatus, Output_Caller
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Output_ApplyPatchOutputStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ApplyPatchCallOutputType"
}
},
"required": [
"type",
"call_id",
"status"
],
"type": "object"
}Output_ApplyPatchCallOutputType
Complete JSON Schema
{
"enum": [
"apply_patch_call_output"
],
"type": "string"
}Output_ApplyPatchCallType
Complete JSON Schema
{
"enum": [
"apply_patch_call"
],
"type": "string"
}Output_ApplyPatchCreate
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"diff": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"path",
"diff"
],
"type": "object"
}Output_ApplyPatchDelete
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
}
},
"required": [
"path"
],
"type": "object"
}Output_ApplyPatchOperation
Complete JSON Schema
Referenced structures: Output_ApplyPatchCreate, Output_ApplyPatchDelete, Output_ApplyPatchUpdate
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_ApplyPatchCreate",
"properties": {
"type": {
"const": "create_file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ApplyPatchDelete",
"properties": {
"type": {
"const": "delete_file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ApplyPatchUpdate",
"properties": {
"type": {
"const": "update_file",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ApplyPatchOutputStatus
Complete JSON Schema
{
"enum": [
"completed",
"failed"
],
"type": "string"
}Output_ApplyPatchStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed"
],
"type": "string"
}Output_ApplyPatchTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_ApplyPatchToolType
Complete JSON Schema
{
"enum": [
"freeform"
],
"type": "string"
}Output_ApplyPatchUpdate
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"diff": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"path",
"diff"
],
"type": "object"
}Output_ApprovalMessages
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"never": {
"type": [
"string",
"null"
]
},
"on_request": {
"type": [
"string",
"null"
]
},
"on_request_auto_review": {
"type": [
"string",
"null"
]
},
"unless_trusted": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_AsyncClassifierMode
Complete JSON Schema
{
"enum": [
"snapshot",
"conversation"
],
"type": "string"
}Output_AttributionSourceId
Complete JSON Schema
Referenced structures: Output_GroundingPassageId, Output_SemanticRetrieverChunk
{
"additionalProperties": true,
"properties": {
"groundingPassage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GroundingPassageId"
},
{
"type": "null"
}
]
},
"semanticRetrieverChunk": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SemanticRetrieverChunk"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_AudioDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"delta": {
"type": "string"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"delta"
],
"type": "object"
}Output_AudioDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number"
],
"type": "object"
}Output_AudioTranscriptDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"delta": {
"type": "string"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"delta"
],
"type": "object"
}Output_AudioTranscriptDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number"
],
"type": "object"
}Output_AudioTranscription
Complete JSON Schema
Referenced structures: Output_WordInfo
{
"additionalProperties": true,
"properties": {
"speakerLabel": {
"type": [
"string",
"null"
]
},
"text": {
"type": "string"
},
"words": {
"items": {
"$ref": "#/components/schemas/Output_WordInfo"
},
"type": [
"array",
"null"
]
}
},
"required": [
"text"
],
"type": "object"
}Output_AudioTranscription2
Complete JSON Schema
Referenced structures: Output_AudioTranscriptionDelay
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/audio_transcription.py`, `AudioTranscription`.",
"properties": {
"delay": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AudioTranscriptionDelay"
},
{
"type": "null"
}
]
},
"keywords": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"language": {
"type": [
"string",
"null"
]
},
"languages": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"model": {
"type": [
"string",
"null"
]
},
"prompt": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_AudioTranscriptionDelay
Complete JSON Schema
{
"enum": [
"minimal",
"low",
"medium",
"high",
"xhigh"
],
"type": "string"
}Output_AuditEventDto
Complete JSON Schema
{
"properties": {
"action": {
"description": "The operation's name, e.g. `users.create`.",
"type": "string"
},
"actorApiKeyId": {
"type": [
"string",
"null"
]
},
"actorUserId": {
"type": [
"string",
"null"
]
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"detail": {
"description": "The redacted request summary the operation wrote. Never a secret: see\n[`AuditEntry::redacted`](crate::audit::AuditEntry::redacted)."
},
"entityId": {
"type": [
"string",
"null"
]
},
"entityKind": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"outcome": {
"description": "`ok` or `error`. A rejected operation is audited too.",
"type": "string"
},
"sourceIp": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"actorUserId",
"actorApiKeyId",
"sourceIp",
"action",
"entityKind",
"entityId",
"outcome",
"detail",
"createdAtMs"
],
"type": "object"
}Output_AuthCodeStarted
Complete JSON Schema
{
"properties": {
"authorizeUrl": {
"description": "Where to send the person's browser.",
"type": "string"
},
"loginSessionId": {
"description": "Names the pending session in every later step. It is not a secret, but\nwhoever holds it can complete this login.",
"type": "string"
},
"redirectUri": {
"description": "The redirect the channel actually asked for, which is what the callback\nwill arrive at.",
"type": "string"
}
},
"required": [
"loginSessionId",
"authorizeUrl",
"redirectUri"
],
"type": "object"
}Output_AuthorizationDenied
Complete JSON Schema
{
"description": "A refused authorization, as RFC 6749 §4.1.2.1's error redirect.\n\nThe refusal goes to the client's registered redirect URI rather than to the\nbrowser as an error page, because the client is what has to learn the\noutcome — and it only ever goes there once the redirect URI has been proven\nregistered. A request whose `client_id` or `redirect_uri` is itself invalid\nis refused before any of this exists, so a forged redirect target cannot be\nused to bounce an error (and a `state`) to an attacker.",
"properties": {
"error": {
"description": "Usually `access_denied`.",
"type": "string"
},
"error_description": {
"type": "string"
},
"redirect_uri": {
"type": "string"
},
"state": {
"type": [
"string",
"null"
]
}
},
"required": [
"redirect_uri",
"state",
"error",
"error_description"
],
"type": "object"
}Output_AuthorizationIssued
Complete JSON Schema
{
"description": "An approved authorization. `code` is plaintext and exists only here.",
"properties": {
"code": {
"type": "string"
},
"redirect_uri": {
"type": "string"
},
"state": {
"type": [
"string",
"null"
]
}
},
"required": [
"code",
"redirect_uri",
"state"
],
"type": "object"
}Output_AuthorizationServerMetadata
Complete JSON Schema
{
"description": "RFC 8414 §2, restricted to what this issuer actually implements.\n\nv3 never served this document, so every client had its endpoints compiled\nin. Publishing it is what lets a client discover the mount it was pointed\nat instead of assuming one.",
"properties": {
"authorization_endpoint": {
"type": "string"
},
"code_challenge_methods_supported": {
"description": "`[\"S256\"]`. `plain` is deliberately absent.",
"items": {
"type": "string"
},
"type": "array"
},
"device_authorization_endpoint": {
"description": "RFC 8628 §4.",
"type": "string"
},
"grant_types_supported": {
"items": {
"type": "string"
},
"type": "array"
},
"issuer": {
"description": "The issuer identifier: exactly the mount this document was fetched\nfrom, with no trailing slash (RFC 8414 §2).",
"type": "string"
},
"response_types_supported": {
"description": "`[\"code\"]`.",
"items": {
"type": "string"
},
"type": "array"
},
"revocation_endpoint": {
"description": "RFC 7009 §2.",
"type": "string"
},
"revocation_endpoint_auth_methods_supported": {
"description": "`[\"none\"]` as well, for the revocation endpoint.",
"items": {
"type": "string"
},
"type": "array"
},
"token_endpoint": {
"type": "string"
},
"token_endpoint_auth_methods_supported": {
"description": "`[\"none\"]`: every registered client is public and this registry issues\nno client secrets.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"issuer",
"authorization_endpoint",
"token_endpoint",
"device_authorization_endpoint",
"revocation_endpoint",
"response_types_supported",
"grant_types_supported",
"code_challenge_methods_supported",
"token_endpoint_auth_methods_supported",
"revocation_endpoint_auth_methods_supported"
],
"type": "object"
}Output_AuthorizeDetails
Complete JSON Schema
{
"description": "What a consent screen renders, once the request has been found valid.\n\nReturned by [`Issuer::authorize_details`](crate::operations::issuer::Issuer::authorize_details),\nwhich validates everything an approval would validate. A screen built from\nthis can therefore show the user a decision that will actually be honoured\nrather than one that fails after they take it.",
"properties": {
"client_id": {
"type": "string"
},
"client_name": {
"description": "`oauth_clients.name`, which is what the user recognises. The id is a\nstring a binary was compiled with and means nothing to them.",
"type": "string"
},
"redirect_uri": {
"description": "The exact registered redirect URI the code would be delivered to.",
"type": "string"
},
"scopes": {
"description": "The requested scopes, already split on whitespace and deduplicated.",
"items": {
"type": "string"
},
"type": "array"
},
"state": {
"type": [
"string",
"null"
]
},
"user_id": {
"description": "The user a consent would bind the grant to.",
"type": "string"
}
},
"required": [
"client_id",
"client_name",
"scopes",
"redirect_uri",
"state",
"user_id"
],
"type": "object"
}Output_AuthorizeOutcome
Complete JSON Schema
Referenced structures: Output_AuthorizationDenied, Output_AuthorizationIssued
{
"description": "The result of a consent decision: in both directions, a redirect back to\nthe client.",
"oneOf": [
{
"$ref": "#/components/schemas/Output_AuthorizationIssued",
"properties": {
"outcome": {
"const": "issued",
"type": "string"
}
},
"required": [
"outcome"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_AuthorizationDenied",
"properties": {
"outcome": {
"const": "denied",
"type": "string"
}
},
"required": [
"outcome"
],
"type": "object"
}
]
}Output_AutoContainerType
Complete JSON Schema
{
"enum": [
"auto"
],
"type": "string"
}Output_AutoReviewMessages
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"node_repl_policy": {
"type": [
"string",
"null"
]
},
"policy": {
"type": [
"string",
"null"
]
},
"policy_template": {
"type": [
"string",
"null"
]
},
"rejection_instructions": {
"type": [
"string",
"null"
]
},
"timeout_instructions": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_Base64SourceType
Complete JSON Schema
{
"enum": [
"base64"
],
"type": "string"
}Output_BashCodeExecutionError
Complete JSON Schema
Referenced structures: Output_BashCodeExecutionErrorCode, Output_BashCodeExecutionErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Output_BashCodeExecutionErrorCode"
},
"type": {
"$ref": "#/components/schemas/Output_BashCodeExecutionErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Output_BashCodeExecutionErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded",
"output_file_too_large"
],
"type": "string"
}Output_BashCodeExecutionErrorType
Complete JSON Schema
{
"enum": [
"bash_code_execution_tool_result_error"
],
"type": "string"
}Output_BashCodeExecutionOutput
Complete JSON Schema
Referenced structures: Output_BashCodeExecutionOutputType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_BashCodeExecutionOutputType"
}
},
"required": [
"type",
"file_id"
],
"type": "object"
}Output_BashCodeExecutionOutputType
Complete JSON Schema
{
"enum": [
"bash_code_execution_output"
],
"type": "string"
}Output_BashCodeExecutionResult
Complete JSON Schema
Referenced structures: Output_BashCodeExecutionOutput, Output_BashCodeExecutionResultType
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_BashCodeExecutionOutput"
},
"type": "array"
},
"return_code": {
"format": "int64",
"type": "integer"
},
"stderr": {
"type": "string"
},
"stdout": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_BashCodeExecutionResultType"
}
},
"required": [
"type",
"content",
"return_code",
"stderr",
"stdout"
],
"type": "object"
}Output_BashCodeExecutionResultContent
Complete JSON Schema
Referenced structures: Output_BashCodeExecutionError, Output_BashCodeExecutionResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_BashCodeExecutionError"
},
{
"$ref": "#/components/schemas/Output_BashCodeExecutionResult"
}
]
}Output_BashCodeExecutionResultType
Complete JSON Schema
{
"enum": [
"bash_code_execution_result"
],
"type": "string"
}Output_BatchEmbedContentsResponseBody
Complete JSON Schema
Referenced structures: Output_ContentEmbedding, Output_EmbeddingUsageMetadata
{
"additionalProperties": true,
"properties": {
"embeddings": {
"items": {
"$ref": "#/components/schemas/Output_ContentEmbedding"
},
"type": [
"array",
"null"
]
},
"usageMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_EmbeddingUsageMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_BidiGenerateContentServerContent
Complete JSON Schema
Referenced structures: Output_BidiGenerateContentTranscription, Output_GroundingMetadata, Output_InteractionStatus, Output_LiveContent, Output_SpeechState, Output_TurnCompleteReason, Output_UrlContextMetadata
{
"additionalProperties": true,
"properties": {
"generationComplete": {
"type": [
"boolean",
"null"
]
},
"groundingMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GroundingMetadata"
},
{
"type": "null"
}
]
},
"inputTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentTranscription"
},
{
"type": "null"
}
]
},
"interactionStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_InteractionStatus"
},
{
"type": "null"
}
]
},
"interimInputTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentTranscription"
},
{
"type": "null"
}
]
},
"interrupted": {
"type": [
"boolean",
"null"
]
},
"modelTurn": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveContent"
},
{
"type": "null"
}
]
},
"outputTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentTranscription"
},
{
"type": "null"
}
]
},
"speechState": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SpeechState"
},
{
"type": "null"
}
]
},
"turnComplete": {
"type": [
"boolean",
"null"
]
},
"turnCompleteReason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TurnCompleteReason"
},
{
"type": "null"
}
]
},
"urlContextMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UrlContextMetadata"
},
{
"type": "null"
}
]
},
"waitingForInput": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Output_BidiGenerateContentSetupComplete
Complete JSON Schema
Referenced structures: Output_VoiceConsentSignature
{
"additionalProperties": true,
"properties": {
"sessionId": {
"type": [
"string",
"null"
]
},
"voiceConsentSignature": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VoiceConsentSignature"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_BidiGenerateContentToolCall
Complete JSON Schema
Referenced structures: Output_FunctionCall2
{
"additionalProperties": true,
"properties": {
"functionCalls": {
"items": {
"$ref": "#/components/schemas/Output_FunctionCall2"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_BidiGenerateContentToolCallCancellation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"ids": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_BidiGenerateContentTranscription
Complete JSON Schema
Referenced structures: Output_WordInfo2
{
"additionalProperties": true,
"properties": {
"finished": {
"type": [
"boolean",
"null"
]
},
"languageCode": {
"type": [
"string",
"null"
]
},
"speakerLabel": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"words": {
"items": {
"$ref": "#/components/schemas/Output_WordInfo2"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_Blob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"displayName": {
"type": [
"string",
"null"
]
},
"mimeType": {
"type": "string"
}
},
"required": [
"mimeType",
"data"
],
"type": "object"
}Output_BlockReason
Complete JSON Schema
{
"enum": [
"BLOCK_REASON_UNSPECIFIED",
"SAFETY",
"OTHER",
"BLOCKLIST",
"PROHIBITED_CONTENT",
"IMAGE_SAFETY"
],
"type": "string"
}Output_BudgetStatusDto
Complete JSON Schema
{
"description": "A caller budget's current window.",
"properties": {
"endsAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"limit": {
"type": "string"
},
"modelPattern": {
"type": [
"string",
"null"
]
},
"ownerId": {
"type": "string"
},
"ownerKind": {
"type": "string"
},
"period": {
"type": "string"
},
"quotaId": {
"type": "string"
},
"resetsAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"startsAtMs": {
"format": "int64",
"type": "integer"
},
"unit": {
"type": "string"
},
"used": {
"type": "string"
},
"windowId": {
"type": "string"
},
"windowKey": {
"type": "string"
}
},
"required": [
"quotaId",
"ownerKind",
"ownerId",
"windowKey",
"period",
"modelPattern",
"unit",
"limit",
"used",
"windowId",
"startsAtMs",
"endsAtMs",
"resetsAtMs"
],
"type": "object"
}Output_CacheControl
Complete JSON Schema
Referenced structures: Output_CacheControlType, Output_CacheTtl
{
"additionalProperties": true,
"properties": {
"ttl": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheTtl"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_CacheControlType"
}
},
"required": [
"type"
],
"type": "object"
}Output_CacheControlType
Complete JSON Schema
{
"enum": [
"ephemeral"
],
"type": "string"
}Output_CacheCreation
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"ephemeral_1h_input_tokens": {
"format": "int64",
"type": "integer"
},
"ephemeral_5m_input_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"ephemeral_1h_input_tokens",
"ephemeral_5m_input_tokens"
],
"type": "object"
}Output_CacheCreationDto
Complete JSON Schema
{
"description": "Reported cache writes for one retention duration. None means unknown TTL.",
"properties": {
"tokens": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"ttlSeconds": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"tokens",
"ttlSeconds"
],
"type": "object"
}Output_CacheCreationPriceDto
Complete JSON Schema
{
"description": "A cache-write price per million tokens. No TTL is the fallback price.",
"properties": {
"price": {
"type": "string"
},
"ttlSeconds": {
"default": null,
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"ttlSeconds",
"price"
],
"type": "object"
}Output_CacheMiss
Complete JSON Schema
Referenced structures: Output_CacheMissReason
{
"additionalProperties": true,
"properties": {
"cache_missed_tokens": {
"format": "int64",
"type": "integer"
},
"comparison_reusable_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"reason": {
"$ref": "#/components/schemas/Output_CacheMissReason"
}
},
"required": [
"cache_missed_tokens",
"reason"
],
"type": "object"
}Output_CacheMissMessagesChanged
Complete JSON Schema
Referenced structures: Output_CacheMissMessagesChangedType
{
"additionalProperties": true,
"properties": {
"cache_missed_input_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_CacheMissMessagesChangedType"
}
},
"required": [
"type",
"cache_missed_input_tokens"
],
"type": "object"
}Output_CacheMissMessagesChangedType
Complete JSON Schema
{
"enum": [
"messages_changed"
],
"type": "string"
}Output_CacheMissModelChanged
Complete JSON Schema
Referenced structures: Output_CacheMissModelChangedType
{
"additionalProperties": true,
"properties": {
"cache_missed_input_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_CacheMissModelChangedType"
}
},
"required": [
"type",
"cache_missed_input_tokens"
],
"type": "object"
}Output_CacheMissModelChangedType
Complete JSON Schema
{
"enum": [
"model_changed"
],
"type": "string"
}Output_CacheMissPreviousMessageNotFound
Complete JSON Schema
Referenced structures: Output_CacheMissPreviousMessageNotFoundType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_CacheMissPreviousMessageNotFoundType"
}
},
"required": [
"type"
],
"type": "object"
}Output_CacheMissPreviousMessageNotFoundType
Complete JSON Schema
{
"enum": [
"previous_message_not_found"
],
"type": "string"
}Output_CacheMissReason
Complete JSON Schema
{
"enum": [
"model_changed",
"prompt_cache_key_changed",
"service_tier_changed",
"tools_changed",
"text_format_changed",
"reasoning_effort_changed",
"verbosity_changed",
"context_compacted",
"input_changed"
],
"type": "string"
}Output_CacheMissReason2
Complete JSON Schema
Referenced structures: Output_CacheMissMessagesChanged, Output_CacheMissModelChanged, Output_CacheMissPreviousMessageNotFound, Output_CacheMissSystemChanged, Output_CacheMissToolsChanged, Output_CacheMissUnavailable
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheMissModelChanged"
},
{
"$ref": "#/components/schemas/Output_CacheMissSystemChanged"
},
{
"$ref": "#/components/schemas/Output_CacheMissToolsChanged"
},
{
"$ref": "#/components/schemas/Output_CacheMissMessagesChanged"
},
{
"$ref": "#/components/schemas/Output_CacheMissPreviousMessageNotFound"
},
{
"$ref": "#/components/schemas/Output_CacheMissUnavailable"
}
]
}Output_CacheMissSystemChanged
Complete JSON Schema
Referenced structures: Output_CacheMissSystemChangedType
{
"additionalProperties": true,
"properties": {
"cache_missed_input_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_CacheMissSystemChangedType"
}
},
"required": [
"type",
"cache_missed_input_tokens"
],
"type": "object"
}Output_CacheMissSystemChangedType
Complete JSON Schema
{
"enum": [
"system_changed"
],
"type": "string"
}Output_CacheMissToolsChanged
Complete JSON Schema
Referenced structures: Output_CacheMissToolsChangedType
{
"additionalProperties": true,
"properties": {
"cache_missed_input_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_CacheMissToolsChangedType"
}
},
"required": [
"type",
"cache_missed_input_tokens"
],
"type": "object"
}Output_CacheMissToolsChangedType
Complete JSON Schema
{
"enum": [
"tools_changed"
],
"type": "string"
}Output_CacheMissUnavailable
Complete JSON Schema
Referenced structures: Output_CacheMissUnavailableType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_CacheMissUnavailableType"
}
},
"required": [
"type"
],
"type": "object"
}Output_CacheMissUnavailableType
Complete JSON Schema
{
"enum": [
"unavailable"
],
"type": "string"
}Output_CacheTtl
Complete JSON Schema
{
"enum": [
"5m",
"1h"
],
"type": "string"
}Output_CacheWriteTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"description": "Non-overlapping write counts by lifetime; their sum is `cache_write_tokens`.\nSource: upstream_docs/openai/docs/Prompt caching.md, Monitor cache performance.",
"properties": {
"ttl_12h_tokens": {
"format": "int64",
"type": "integer"
},
"ttl_30m_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"ttl_30m_tokens",
"ttl_12h_tokens"
],
"type": "object"
}Output_Caller
Complete JSON Schema
Referenced structures: Output_DirectCaller, Output_ProgramCaller
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_DirectCaller",
"properties": {
"type": {
"const": "direct",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ProgramCaller",
"properties": {
"type": {
"const": "program",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_Caller2
Complete JSON Schema
Referenced structures: Output_DirectCaller2, Output_ServerCaller, Output_ServerCaller20260120
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_DirectCaller2",
"properties": {
"type": {
"const": "direct",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ServerCaller",
"properties": {
"type": {
"const": "code_execution_20250825",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ServerCaller20260120",
"properties": {
"type": {
"const": "code_execution_20260120",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_Candidate
Complete JSON Schema
Referenced structures: Output_CitationMetadata, Output_Content, Output_FinishReason, Output_GroundingAttribution, Output_GroundingMetadata, Output_LogprobsResult, Output_SafetyRating, Output_UrlContextMetadata
{
"additionalProperties": true,
"properties": {
"avgLogprobs": {
"format": "double",
"type": [
"number",
"null"
]
},
"citationMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CitationMetadata"
},
{
"type": "null"
}
]
},
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Content"
},
{
"type": "null"
}
]
},
"continuationToken": {
"type": [
"string",
"null"
]
},
"finishMessage": {
"type": [
"string",
"null"
]
},
"finishReason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FinishReason"
},
{
"type": "null"
}
]
},
"groundingAttributions": {
"items": {
"$ref": "#/components/schemas/Output_GroundingAttribution"
},
"type": [
"array",
"null"
]
},
"groundingMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GroundingMetadata"
},
{
"type": "null"
}
]
},
"index": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"logprobsResult": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LogprobsResult"
},
{
"type": "null"
}
]
},
"safetyRatings": {
"items": {
"$ref": "#/components/schemas/Output_SafetyRating"
},
"type": [
"array",
"null"
]
},
"tokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"urlContextMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UrlContextMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_CapabilitySupport
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"supported": {
"type": "boolean"
}
},
"required": [
"supported"
],
"type": "object"
}Output_CaptureDetailDto
Complete JSON Schema
Referenced structures: Output_CaptureEventDto, Output_CaptureRecordDto
{
"description": "One physical capture, readable even when the downstream log is disabled.",
"properties": {
"events": {
"items": {
"$ref": "#/components/schemas/Output_CaptureEventDto"
},
"type": "array"
},
"eventsTruncated": {
"type": "boolean"
},
"record": {
"$ref": "#/components/schemas/Output_CaptureRecordDto"
}
},
"required": [
"record",
"events",
"eventsTruncated"
],
"type": "object"
}Output_CaptureEventDto
Complete JSON Schema
Referenced structures: Output_LogBodyDto
{
"description": "One stream chunk or websocket message.",
"properties": {
"captureId": {
"type": "string"
},
"direction": {
"description": "`request` (client to gateway, gateway to provider) or `response`.",
"type": "string"
},
"kind": {
"description": "`bytes`, `ws_text`, `ws_binary`, `ws_ping`, `ws_pong` or `ws_close`.",
"type": "string"
},
"observedAtMs": {
"format": "int64",
"type": "integer"
},
"payload": {
"$ref": "#/components/schemas/Output_LogBodyDto"
},
"sequence": {
"description": "Monotonic across both directions of the exchange or connection.",
"format": "int64",
"type": "integer"
},
"turnId": {
"type": [
"string",
"null"
]
}
},
"required": [
"captureId",
"sequence",
"turnId",
"direction",
"kind",
"payload",
"observedAtMs"
],
"type": "object"
}Output_CaptureRecordDto
Complete JSON Schema
Referenced structures: Output_LogBodyDto
{
"description": "One captured exchange in full, downstream or upstream.",
"properties": {
"agentAssignmentId": {
"type": [
"string",
"null"
]
},
"apiKeyId": {
"type": [
"string",
"null"
]
},
"attemptId": {
"type": [
"string",
"null"
]
},
"attemptOrdinal": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"clientIp": {
"type": [
"string",
"null"
]
},
"credentialId": {
"type": [
"string",
"null"
]
},
"endedAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"error": {
"type": [
"string",
"null"
]
},
"firstResponseAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"type": "string"
},
"initiatorRequestId": {
"description": "Initiating request for provenance; actual associations are many-to-many.",
"type": [
"string",
"null"
]
},
"kind": {
"description": "`http`, `ws_connection` or `ws_turn`.",
"type": "string"
},
"metrics": {
"description": "Upstream-native usage for this one exchange, when the channel reported\nany. Billed usage is on the usage record, not here."
},
"model": {
"type": [
"string",
"null"
]
},
"operation": {
"type": [
"string",
"null"
]
},
"providerId": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"requestBody": {
"$ref": "#/components/schemas/Output_LogBodyDto"
},
"requestFraming": {
"description": "`buffered`, `bytes`, `sse`, `ndjson`, `json_array` or `websocket`.\nHTTP bodies are reconstructed regardless of transport framing;\nWebSocket messages retain their boundaries in the events.",
"type": "string"
},
"requestHeaders": {
"description": "`[[name, value], …]`, repeated headers preserved."
},
"requestMethod": {
"type": [
"string",
"null"
]
},
"requestQuery": {
"type": [
"string",
"null"
]
},
"requestUrl": {
"type": [
"string",
"null"
]
},
"responseBody": {
"$ref": "#/components/schemas/Output_LogBodyDto"
},
"responseFraming": {
"type": "string"
},
"responseHeaders": true,
"responseStatus": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"sessionId": {
"type": [
"string",
"null"
]
},
"side": {
"description": "`downstream` or `upstream`.",
"type": "string"
},
"startedAtMs": {
"format": "int64",
"type": "integer"
},
"state": {
"type": "string"
},
"streamKey": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"initiatorRequestId",
"attemptId",
"attemptOrdinal",
"side",
"kind",
"sessionId",
"streamKey",
"userId",
"apiKeyId",
"providerId",
"credentialId",
"agentAssignmentId",
"model",
"operation",
"requestMethod",
"requestUrl",
"requestQuery",
"requestHeaders",
"requestBody",
"requestFraming",
"responseStatus",
"responseHeaders",
"responseBody",
"responseFraming",
"clientIp",
"metrics",
"state",
"error",
"reason",
"startedAtMs",
"firstResponseAtMs",
"endedAtMs"
],
"type": "object"
}Output_CatalogProviderDto
Complete JSON Schema
{
"properties": {
"displayName": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName"
],
"type": "object"
}Output_ChannelCapabilities
Complete JSON Schema
{
"description": "Optional abilities beyond protocol operations. All false is a legitimate\nchannel: an API-key upstream needs none of them.",
"properties": {
"paidUsage": {
"description": "`QuotaModel::allows_paid_usage` reads the credential metadata flag\n`allow_paid_usage`, so the console offers the switch. Not derivable\neither: the method has a default, and overriding it is invisible here.",
"type": "boolean"
},
"quotaQuery": {
"description": "`QuotaQuery`: the upstream can be asked about the account's balance.",
"type": "boolean"
},
"quotaReset": {
"description": "`QuotaReset`: a spent window can be reopened against the upstream.",
"type": "boolean"
},
"refresh": {
"description": "`CredentialRefresh`: the credential can be renewed without a person.",
"type": "boolean"
},
"services": {
"description": "`ChannelServices`: non-protocol endpoints of the upstream's own client.",
"type": "boolean"
},
"websocket": {
"description": "The channel serves at least one operation over a WebSocket. Not\nderivable from an accessor; a channel that overrides a socket operation\ndeclares it.",
"type": "boolean"
}
},
"required": [
"refresh",
"quotaQuery",
"quotaReset",
"services",
"websocket",
"paidUsage"
],
"type": "object"
}Output_ChannelDescriptor
Complete JSON Schema
Referenced structures: Output_ChannelCapabilities, Output_ConfigKey, Output_LoginMode
{
"description": "A channel as the management layer sees it.",
"properties": {
"capabilities": {
"$ref": "#/components/schemas/Output_ChannelCapabilities"
},
"configKeys": {
"items": {
"$ref": "#/components/schemas/Output_ConfigKey"
},
"type": "array"
},
"credentialKinds": {
"description": "Stored credential types accepted on manual creation, distinct from login flows.",
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"type": "string"
},
"id": {
"description": "Matches `BaseChannel::id` and the provider's `channel` column.",
"type": "string"
},
"loginModes": {
"description": "Empty means no login flow is offered for this channel.",
"items": {
"$ref": "#/components/schemas/Output_LoginMode"
},
"type": "array"
}
},
"required": [
"id",
"displayName",
"loginModes",
"credentialKinds",
"capabilities",
"configKeys"
],
"type": "object"
}Output_ChatCompletionChunk
Complete JSON Schema
Referenced structures: Output_ChunkObject, Output_ChunkUsage, Output_ModerationResponse, Output_ResponseServiceTier2, Output_StreamChoice
{
"additionalProperties": true,
"properties": {
"choices": {
"items": {
"$ref": "#/components/schemas/Output_StreamChoice"
},
"type": "array"
},
"created": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"model": {
"type": "string"
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModerationResponse"
},
{
"type": "null"
}
]
},
"obfuscation": {
"type": [
"string",
"null"
]
},
"object": {
"$ref": "#/components/schemas/Output_ChunkObject"
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseServiceTier2"
},
{
"type": "null"
}
]
},
"system_fingerprint": {
"type": [
"string",
"null"
]
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ChunkUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"choices",
"created",
"model",
"object"
],
"type": "object"
}Output_ChatToolCall
Complete JSON Schema
Referenced structures: Output_ChatToolCallType, Output_FunctionCall3
{
"additionalProperties": true,
"properties": {
"function": {
"$ref": "#/components/schemas/Output_FunctionCall3"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ChatToolCallType"
}
},
"required": [
"id",
"function",
"type"
],
"type": "object"
}Output_ChatToolCallType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Output_Choice
Complete JSON Schema
Referenced structures: Output_FinishReason2, Output_Logprobs, Output_ResponseMessage
{
"additionalProperties": true,
"properties": {
"finish_reason": {
"$ref": "#/components/schemas/Output_FinishReason2"
},
"index": {
"format": "int64",
"type": "integer"
},
"logprobs": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Logprobs"
},
{
"type": "null"
}
],
"default": null
},
"message": {
"$ref": "#/components/schemas/Output_ResponseMessage"
}
},
"required": [
"finish_reason",
"index",
"logprobs",
"message"
],
"type": "object"
}Output_ChunkCompletionTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"accepted_prediction_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"rejected_prediction_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_ChunkLogprobs
Complete JSON Schema
Referenced structures: Output_ChunkTokenLogprob
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_ChunkTokenLogprob"
},
"type": [
"array",
"null"
]
},
"refusal": {
"items": {
"$ref": "#/components/schemas/Output_ChunkTokenLogprob"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_ChunkObject
Complete JSON Schema
{
"enum": [
"chat.completion.chunk"
],
"type": "string"
}Output_ChunkPromptTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cache_write_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cached_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"image_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_ChunkTokenLogprob
Complete JSON Schema
Referenced structures: Output_ChunkTopLogprob
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"logprob": {
"format": "double",
"type": "number"
},
"token": {
"type": "string"
},
"top_logprobs": {
"items": {
"$ref": "#/components/schemas/Output_ChunkTopLogprob"
},
"type": "array"
}
},
"required": [
"token",
"logprob",
"top_logprobs"
],
"type": "object"
}Output_ChunkTopLogprob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"logprob": {
"format": "double",
"type": "number"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"logprob"
],
"type": "object"
}Output_ChunkUsage
Complete JSON Schema
Referenced structures: Output_ChunkCompletionTokensDetails, Output_ChunkPromptTokensDetails
{
"additionalProperties": true,
"properties": {
"completion_tokens": {
"format": "int64",
"type": "integer"
},
"completion_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ChunkCompletionTokensDetails"
},
{
"type": "null"
}
]
},
"prompt_tokens": {
"format": "int64",
"type": "integer"
},
"prompt_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ChunkPromptTokensDetails"
},
{
"type": "null"
}
]
},
"total_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"completion_tokens",
"prompt_tokens",
"total_tokens"
],
"type": "object"
}Output_CitationMetadata
Complete JSON Schema
Referenced structures: Output_CitationSource
{
"additionalProperties": true,
"properties": {
"citationSources": {
"items": {
"$ref": "#/components/schemas/Output_CitationSource"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_CitationSource
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endIndex": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"license": {
"type": [
"string",
"null"
]
},
"startIndex": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"uri": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_CitationsDelta
Complete JSON Schema
Referenced structures: Output_ResponseTextCitation
{
"additionalProperties": true,
"properties": {
"citation": {
"$ref": "#/components/schemas/Output_ResponseTextCitation"
}
},
"required": [
"citation"
],
"type": "object"
}Output_ClearedThinking
Complete JSON Schema
Referenced structures: Output_ClearedThinkingType
{
"additionalProperties": true,
"properties": {
"cleared_input_tokens": {
"format": "int64",
"type": "integer"
},
"cleared_thinking_turns": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ClearedThinkingType"
}
},
"required": [
"type",
"cleared_input_tokens",
"cleared_thinking_turns"
],
"type": "object"
}Output_ClearedThinkingType
Complete JSON Schema
{
"enum": [
"clear_thinking_20251015"
],
"type": "string"
}Output_ClearedTools
Complete JSON Schema
Referenced structures: Output_ClearedToolsType
{
"additionalProperties": true,
"properties": {
"cleared_input_tokens": {
"format": "int64",
"type": "integer"
},
"cleared_tool_uses": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ClearedToolsType"
}
},
"required": [
"type",
"cleared_input_tokens",
"cleared_tool_uses"
],
"type": "object"
}Output_ClearedToolsType
Complete JSON Schema
{
"enum": [
"clear_tool_uses_20250919"
],
"type": "string"
}Output_ClickAction
Complete JSON Schema
Referenced structures: Output_ClickButton
{
"additionalProperties": true,
"properties": {
"button": {
"$ref": "#/components/schemas/Output_ClickButton"
},
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"button",
"x",
"y"
],
"type": "object"
}Output_ClickButton
Complete JSON Schema
{
"enum": [
"left",
"right",
"wheel",
"back",
"forward"
],
"type": "string"
}Output_ClientSecretResponseSession
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponse, Output_RealtimeTranscriptionSessionCreateResponse
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponse"
},
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateResponse"
}
]
}Output_ClientVersion
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"maxItems": 3,
"minItems": 3,
"type": "array"
}
]
}Output_CodeExecutionError
Complete JSON Schema
Referenced structures: Output_CodeExecutionErrorCode, Output_CodeExecutionErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Output_CodeExecutionErrorCode"
},
"type": {
"$ref": "#/components/schemas/Output_CodeExecutionErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Output_CodeExecutionErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded"
],
"type": "string"
}Output_CodeExecutionErrorType
Complete JSON Schema
{
"enum": [
"code_execution_tool_result_error"
],
"type": "string"
}Output_CodeExecutionOutput
Complete JSON Schema
Referenced structures: Output_CodeExecutionOutputType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_CodeExecutionOutputType"
}
},
"required": [
"type",
"file_id"
],
"type": "object"
}Output_CodeExecutionOutputType
Complete JSON Schema
{
"enum": [
"code_execution_output"
],
"type": "string"
}Output_CodeExecutionResult
Complete JSON Schema
Referenced structures: Output_CodeExecutionOutput, Output_CodeExecutionResultType
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_CodeExecutionOutput"
},
"type": "array"
},
"return_code": {
"format": "int64",
"type": "integer"
},
"stderr": {
"type": "string"
},
"stdout": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_CodeExecutionResultType"
}
},
"required": [
"type",
"content",
"return_code",
"stderr",
"stdout"
],
"type": "object"
}Output_CodeExecutionResult2
Complete JSON Schema
Referenced structures: Output_Outcome
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"outcome": {
"$ref": "#/components/schemas/Output_Outcome"
},
"output": {
"type": [
"string",
"null"
]
}
},
"required": [
"outcome"
],
"type": "object"
}Output_CodeExecutionResultContent
Complete JSON Schema
Referenced structures: Output_CodeExecutionError, Output_CodeExecutionResult, Output_EncryptedCodeExecutionResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_CodeExecutionError"
},
{
"$ref": "#/components/schemas/Output_CodeExecutionResult"
},
{
"$ref": "#/components/schemas/Output_EncryptedCodeExecutionResult"
}
]
}Output_CodeExecutionResultType
Complete JSON Schema
{
"enum": [
"code_execution_result"
],
"type": "string"
}Output_CodeImage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"url": {
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}Output_CodeInterpreterAuto
Complete JSON Schema
Referenced structures: Output_AutoContainerType, Output_ContainerNetworkPolicy, Output_MemoryLimit
{
"additionalProperties": true,
"properties": {
"file_ids": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"memory_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MemoryLimit"
},
{
"type": "null"
}
]
},
"network_policy": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ContainerNetworkPolicy"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_AutoContainerType"
}
},
"required": [
"type"
],
"type": "object"
}Output_CodeInterpreterCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_CodeInterpreterCallType, Output_CodeInterpreterOutput, Output_CodeInterpreterStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"code": {
"type": [
"string",
"null"
]
},
"container_id": {
"type": "string"
},
"id": {
"type": "string"
},
"outputs": {
"items": {
"$ref": "#/components/schemas/Output_CodeInterpreterOutput"
},
"type": [
"array",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Output_CodeInterpreterStatus"
},
"type": {
"$ref": "#/components/schemas/Output_CodeInterpreterCallType"
}
},
"required": [
"type",
"id",
"code",
"container_id",
"outputs",
"status"
],
"type": "object"
}Output_CodeInterpreterCallType
Complete JSON Schema
{
"enum": [
"code_interpreter_call"
],
"type": "string"
}Output_CodeInterpreterCodeDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"delta"
],
"type": "object"
}Output_CodeInterpreterCodeDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"code": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"code"
],
"type": "object"
}Output_CodeInterpreterContainer
Complete JSON Schema
Referenced structures: Output_CodeInterpreterAuto
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterAuto"
}
]
}Output_CodeInterpreterEvent
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index"
],
"type": "object"
}Output_CodeInterpreterOutput
Complete JSON Schema
Referenced structures: Output_CodeImage, Output_CodeLogs
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_CodeLogs",
"properties": {
"type": {
"const": "logs",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CodeImage",
"properties": {
"type": {
"const": "image",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_CodeInterpreterStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete",
"interpreting",
"failed"
],
"type": "string"
}Output_CodeInterpreterTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller, Output_CodeInterpreterContainer
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"container": {
"$ref": "#/components/schemas/Output_CodeInterpreterContainer"
}
},
"required": [
"container"
],
"type": "object"
}Output_CodeLogs
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"logs": {
"type": "string"
}
},
"required": [
"logs"
],
"type": "object"
}Output_CodeModeToolMessages
Complete JSON Schema
Referenced structures: Output_ToolMessage
{
"additionalProperties": true,
"properties": {
"deferred_nested_tools_guidance": {
"type": [
"string",
"null"
]
},
"exec": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"mcp_typescript_preamble": {
"type": [
"string",
"null"
]
},
"wait": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_CollaborationModeMessages
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"default": {
"type": [
"string",
"null"
]
},
"plan": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_CompactObject
Complete JSON Schema
{
"enum": [
"response.compaction"
],
"type": "string"
}Output_CompactResponseBody
Complete JSON Schema
Referenced structures: Output_CompactObject, Output_ResponseOutputItem, Output_ResponseUsage
{
"additionalProperties": true,
"properties": {
"created_at": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"object": {
"$ref": "#/components/schemas/Output_CompactObject"
},
"output": {
"items": {
"$ref": "#/components/schemas/Output_ResponseOutputItem"
},
"type": "array"
},
"usage": {
"$ref": "#/components/schemas/Output_ResponseUsage"
}
},
"required": [
"usage",
"id",
"created_at",
"object",
"output"
],
"type": "object"
}Output_Compaction
Complete JSON Schema
Referenced structures: Output_Agent, Output_CompactionType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"encrypted_content": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_CompactionType"
}
},
"required": [
"type",
"encrypted_content"
],
"type": "object"
}Output_CompactionCapability
Complete JSON Schema
Referenced structures: Output_CapabilitySupport
{
"additionalProperties": true,
"properties": {
"summarize": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"supported": {
"type": "boolean"
}
},
"required": [
"supported",
"summarize"
],
"type": "object"
}Output_CompactionDelta
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"content": {
"type": [
"string",
"null"
]
},
"encrypted_content": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_CompactionIterationUsage
Complete JSON Schema
Referenced structures: Output_CacheCreation, Output_CompactionIterationUsageType
{
"additionalProperties": true,
"properties": {
"cache_creation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheCreation"
},
{
"type": "null"
}
]
},
"cache_creation_input_tokens": {
"format": "int64",
"type": "integer"
},
"cache_read_input_tokens": {
"format": "int64",
"type": "integer"
},
"input_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_CompactionIterationUsageType"
}
},
"required": [
"type",
"cache_creation_input_tokens",
"cache_read_input_tokens",
"input_tokens",
"output_tokens"
],
"type": "object"
}Output_CompactionIterationUsageType
Complete JSON Schema
{
"enum": [
"compaction"
],
"type": "string"
}Output_CompactionTrigger
Complete JSON Schema
Referenced structures: Output_Agent, Output_CompactionTriggerType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_CompactionTriggerType"
}
},
"required": [
"type"
],
"type": "object"
}Output_CompactionTriggerType
Complete JSON Schema
{
"enum": [
"compaction_trigger"
],
"type": "string"
}Output_CompactionType
Complete JSON Schema
{
"enum": [
"compaction"
],
"type": "string"
}Output_ComparisonFilter
Complete JSON Schema
Referenced structures: Output_ComparisonFilterType, Output_FilterValue
{
"additionalProperties": true,
"properties": {
"key": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ComparisonFilterType"
},
"value": {
"$ref": "#/components/schemas/Output_FilterValue"
}
},
"required": [
"key",
"value",
"type"
],
"type": "object"
}Output_ComparisonFilterType
Complete JSON Schema
{
"enum": [
"eq",
"ne",
"gt",
"gte",
"lt",
"lte",
"in",
"nin"
],
"type": "string"
}Output_CompletionObject
Complete JSON Schema
{
"enum": [
"chat.completion"
],
"type": "string"
}Output_CompletionTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"accepted_prediction_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"reasoning_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"rejected_prediction_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_CompoundFilter
Complete JSON Schema
Referenced structures: Output_CompoundFilterType, Output_FileSearchFilter
{
"additionalProperties": true,
"properties": {
"filters": {
"items": {
"$ref": "#/components/schemas/Output_FileSearchFilter"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_CompoundFilterType"
}
},
"required": [
"filters",
"type"
],
"type": "object"
}Output_CompoundFilterType
Complete JSON Schema
{
"enum": [
"and",
"or"
],
"type": "string"
}Output_ComputerAction
Complete JSON Schema
Referenced structures: Output_ClickAction, Output_DoubleClickAction, Output_DragAction, Output_KeypressAction, Output_MoveAction, Output_ScreenshotAction, Output_ScrollAction, Output_TypeAction, Output_WaitAction
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_ClickAction",
"properties": {
"type": {
"const": "click",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_DoubleClickAction",
"properties": {
"type": {
"const": "double_click",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_DragAction",
"properties": {
"type": {
"const": "drag",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_KeypressAction",
"properties": {
"type": {
"const": "keypress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_MoveAction",
"properties": {
"type": {
"const": "move",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ScreenshotAction",
"properties": {
"type": {
"const": "screenshot",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ScrollAction",
"properties": {
"type": {
"const": "scroll",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_TypeAction",
"properties": {
"type": {
"const": "type",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_WaitAction",
"properties": {
"type": {
"const": "wait",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ComputerCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_ComputerAction, Output_ComputerCallType, Output_ItemStatus, Output_PendingSafetyCheck
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ComputerAction"
},
{
"type": "null"
}
]
},
"actions": {
"items": {
"$ref": "#/components/schemas/Output_ComputerAction"
},
"type": [
"array",
"null"
]
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"pending_safety_checks": {
"items": {
"$ref": "#/components/schemas/Output_PendingSafetyCheck"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ComputerCallType"
}
},
"required": [
"type",
"id",
"call_id",
"pending_safety_checks",
"status"
],
"type": "object"
}Output_ComputerCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ComputerCallOutputType, Output_ComputerScreenshot, Output_ItemStatus, Output_PendingSafetyCheck
{
"additionalProperties": true,
"properties": {
"acknowledged_safety_checks": {
"items": {
"$ref": "#/components/schemas/Output_PendingSafetyCheck"
},
"type": [
"array",
"null"
]
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Output_ComputerScreenshot"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ComputerCallOutputType"
}
},
"required": [
"type",
"call_id",
"output"
],
"type": "object"
}Output_ComputerCallOutputType
Complete JSON Schema
{
"enum": [
"computer_call_output"
],
"type": "string"
}Output_ComputerCallType
Complete JSON Schema
{
"enum": [
"computer_call"
],
"type": "string"
}Output_ComputerEnvironment
Complete JSON Schema
{
"enum": [
"windows",
"mac",
"linux",
"ubuntu",
"browser"
],
"type": "string"
}Output_ComputerScreenshot
Complete JSON Schema
Referenced structures: Output_ComputerScreenshotType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ComputerScreenshotType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ComputerScreenshotType
Complete JSON Schema
{
"enum": [
"computer_screenshot"
],
"type": "string"
}Output_ComputerTool
Complete JSON Schema
Referenced structures: Output_ComputerEnvironment
{
"additionalProperties": true,
"properties": {
"display_height": {
"format": "int64",
"type": "integer"
},
"display_width": {
"format": "int64",
"type": "integer"
},
"environment": {
"$ref": "#/components/schemas/Output_ComputerEnvironment"
}
},
"required": [
"display_height",
"display_width",
"environment"
],
"type": "object"
}Output_ConfigKey
Complete JSON Schema
Referenced structures: Output_ConfigKeyKind
{
"description": "One entry of a provider's configuration. Unless noted, the name is a key of\nthe provider's `config` JSON; `base_url` is the provider's own column.",
"properties": {
"description": {
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/Output_ConfigKeyKind"
},
"name": {
"type": "string"
},
"placeholder": {
"description": "Display-only default or URL template; never written into config by the UI.",
"type": [
"string",
"null"
]
},
"required": {
"description": "The provider cannot serve a request without it. Everything else has a\nchannel default.",
"type": "boolean"
}
},
"required": [
"name",
"kind",
"required",
"description",
"placeholder"
],
"type": "object"
}Output_ConfigKeyKind
Complete JSON Schema
{
"description": "How a configuration value is written, for form rendering and validation.",
"oneOf": [
{
"enum": [
"string",
"bool",
"integer"
],
"type": "string"
},
{
"const": "json",
"description": "Any other JSON shape: an array, or an object that is not headers.",
"type": "string"
},
{
"const": "header_list",
"description": "HTTP header names, or header name/value pairs.",
"type": "string"
}
]
}Output_ConfigShellToolType
Complete JSON Schema
{
"enum": [
"unified_exec",
"disabled"
],
"type": "string"
}Output_ConfigurationDataDto
Complete JSON Schema
Referenced structures: Output_ConnectionProfileDto, Output_ExportCredentialDto, Output_ModelDto, Output_OperationEndpointDto, Output_OperationRuleDto, Output_PriceRateDto, Output_PriceRuleDto, Output_PriceTierDto, Output_ProviderDto, Output_ProviderModelDto, Output_ProviderRuleSetDto, Output_QuotaDto, Output_RewriteRuleDto, Output_RouteDto, Output_RouteMemberDto, Output_RuleSetDto, Output_SettingsDto
{
"description": "Every exported table, in the order a fresh instance may replay them: a row\nnever appears before the row it points at. Each field defaults to empty, so\na document written by a build that knew fewer tables still imports.",
"properties": {
"connectionProfiles": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_ConnectionProfileDto"
},
"type": "array"
},
"credentials": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_ExportCredentialDto"
},
"type": "array"
},
"models": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_ModelDto"
},
"type": "array"
},
"operationEndpoints": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_OperationEndpointDto"
},
"type": "array"
},
"operationRules": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_OperationRuleDto"
},
"type": "array"
},
"priceRates": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_PriceRateDto"
},
"type": "array"
},
"priceRules": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_PriceRuleDto"
},
"type": "array"
},
"priceTiers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_PriceTierDto"
},
"type": "array"
},
"providerModels": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_ProviderModelDto"
},
"type": "array"
},
"providerRewriteRuleSets": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_ProviderRuleSetDto"
},
"type": "array"
},
"providers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_ProviderDto"
},
"type": "array"
},
"quotas": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_QuotaDto"
},
"type": "array"
},
"rewriteRuleSets": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_RuleSetDto"
},
"type": "array"
},
"rewriteRules": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_RewriteRuleDto"
},
"type": "array"
},
"routeMembers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_RouteMemberDto"
},
"type": "array"
},
"routes": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_RouteDto"
},
"type": "array"
},
"settings": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SettingsDto"
},
{
"type": "null"
}
],
"default": null,
"description": "The single settings row. `config_revision` travels but is never\nimported: the destination's revision is its own counter."
}
},
"required": [
"connectionProfiles",
"providers",
"credentials",
"models",
"providerModels",
"routes",
"routeMembers",
"operationRules",
"operationEndpoints",
"rewriteRuleSets",
"rewriteRules",
"providerRewriteRuleSets",
"quotas",
"priceRules",
"priceRates",
"priceTiers",
"settings"
],
"type": "object"
}Output_ConfigurationExportDto
Complete JSON Schema
Referenced structures: Output_ConfigurationDataDto
{
"description": "One instance's configuration as a document.",
"properties": {
"data": {
"$ref": "#/components/schemas/Output_ConfigurationDataDto"
},
"exportedAtMs": {
"format": "int64",
"type": "integer"
},
"formatVersion": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"secrets": {
"description": "The sealing codecs the exported blobs actually use, sorted and without\nduplicates; empty when the secrets were omitted. An importer reads it\nbefore it starts, to decide whether it needs a source master key at all.",
"items": {
"type": "string"
},
"type": "array"
},
"secretsOmitted": {
"description": "True when the export was taken without secrets: every credential's\n`secret` is null.",
"type": "boolean"
}
},
"required": [
"formatVersion",
"exportedAtMs",
"secretsOmitted",
"secrets",
"data"
],
"type": "object"
}Output_ConfigurationReasoning
Complete JSON Schema
Referenced structures: Output_ReasoningEffort
{
"additionalProperties": true,
"properties": {
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningEffort"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ConfigurationUpdate
Complete JSON Schema
Referenced structures: Output_Agent, Output_ConfigurationReasoning, Output_ConfigurationUpdateType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConfigurationReasoning"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ConfigurationUpdateType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ConfigurationUpdateType
Complete JSON Schema
{
"enum": [
"configuration_update"
],
"type": "string"
}Output_ConfirmationPolicies
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"browser_use": {
"type": [
"string",
"null"
]
},
"computer_use": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ConnectionProfileDto
Complete JSON Schema
{
"additionalProperties": false,
"description": "A reusable HTTP transport configuration, independent of outbound proxy selection.",
"properties": {
"backend": {
"description": "`reqwest`, `wreq` or `reqwest_native`.",
"type": "string"
},
"brotli": {
"type": "boolean"
},
"connectTimeoutMs": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"deflate": {
"type": "boolean"
},
"emulation": {
"description": "A `gproxy-client` emulation object, or null. wreq applies the full identity; other clients apply supported custom fields."
},
"gzip": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"poolIdleTimeoutMs": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"poolMaxIdlePerHost": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"redirectMaxHops": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"retry": {
"description": "`never` or `default`.",
"type": "string"
},
"zstd": {
"type": "boolean"
}
},
"required": [
"id",
"name",
"backend",
"emulation",
"gzip",
"brotli",
"deflate",
"zstd",
"redirectMaxHops",
"retry",
"connectTimeoutMs",
"poolIdleTimeoutMs",
"poolMaxIdlePerHost",
"createdAtMs"
],
"type": "object"
}Output_ConnectivityProbeDto
Complete JSON Schema
{
"properties": {
"colo": {
"type": [
"string",
"null"
]
},
"ip": {
"type": "string"
},
"latencyMs": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"location": {
"type": [
"string",
"null"
]
}
},
"required": [
"ip",
"location",
"colo",
"latencyMs"
],
"type": "object"
}Output_ConnectivityResultDto
Complete JSON Schema
Referenced structures: Output_ConnectivityProbeDto
{
"description": "What the edge looks like from here. `ip` and `colo` come from Cloudflare's\ntrace endpoint, so `ip` is the address the upstream would see — which is\nthe whole point of testing a proxy.",
"properties": {
"colo": {
"description": "The Cloudflare edge that answered, e.g. `NRT`.",
"type": [
"string",
"null"
]
},
"error": {
"description": "Set exactly when `ok` is false.",
"type": [
"string",
"null"
]
},
"ip": {
"type": [
"string",
"null"
]
},
"ipv4": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConnectivityProbeDto"
},
{
"type": "null"
}
]
},
"ipv4Error": {
"type": [
"string",
"null"
]
},
"ipv6": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConnectivityProbeDto"
},
{
"type": "null"
}
]
},
"ipv6Error": {
"type": [
"string",
"null"
]
},
"latencyMs": {
"description": "Measured across the whole exchange, including the body read, and\nreported for a failure too.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"ok": {
"type": "boolean"
},
"proxySource": {
"type": "string"
}
},
"required": [
"ipv4",
"ipv6",
"ipv4Error",
"ipv6Error",
"proxySource",
"ok",
"latencyMs",
"ip",
"colo",
"error"
],
"type": "object"
}Output_ConnectorId
Complete JSON Schema
{
"enum": [
"connector_dropbox",
"connector_gmail",
"connector_googlecalendar",
"connector_googledrive",
"connector_microsoftteams",
"connector_outlookcalendar",
"connector_outlookemail",
"connector_sharepoint"
],
"type": "string"
}Output_ContainerFileCitation
Complete JSON Schema
Referenced structures: Output_ContainerFileCitationType
{
"additionalProperties": true,
"properties": {
"container_id": {
"type": "string"
},
"end_index": {
"format": "int64",
"type": "integer"
},
"file_id": {
"type": "string"
},
"filename": {
"type": "string"
},
"start_index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ContainerFileCitationType"
}
},
"required": [
"container_id",
"end_index",
"file_id",
"filename",
"start_index",
"type"
],
"type": "object"
}Output_ContainerFileCitationType
Complete JSON Schema
{
"enum": [
"container_file_citation"
],
"type": "string"
}Output_ContainerNetworkPolicy
Complete JSON Schema
Referenced structures: Output_NetworkAllowlist, Output_NetworkDisabled
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_NetworkDisabled"
},
{
"$ref": "#/components/schemas/Output_NetworkAllowlist"
}
]
}Output_Content
Complete JSON Schema
Referenced structures: Output_Part
{
"additionalProperties": true,
"properties": {
"parts": {
"items": {
"$ref": "#/components/schemas/Output_Part"
},
"type": [
"array",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ContentBlockDelta
Complete JSON Schema
Referenced structures: Output_CitationsDelta, Output_CompactionDelta, Output_InputJsonDelta, Output_SignatureDelta, Output_TextDelta, Output_ThinkingDelta
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_TextDelta",
"properties": {
"type": {
"const": "text_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_InputJsonDelta",
"properties": {
"type": {
"const": "input_json_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ThinkingDelta",
"properties": {
"type": {
"const": "thinking_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_SignatureDelta",
"properties": {
"type": {
"const": "signature_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CitationsDelta",
"properties": {
"type": {
"const": "citations_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CompactionDelta",
"properties": {
"type": {
"const": "compaction_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ContentBlockDeltaEvent
Complete JSON Schema
Referenced structures: Output_ContentBlockDelta
{
"additionalProperties": true,
"properties": {
"delta": {
"$ref": "#/components/schemas/Output_ContentBlockDelta"
},
"index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"index",
"delta"
],
"type": "object"
}Output_ContentBlockStartEvent
Complete JSON Schema
Referenced structures: Output_ResponseContentBlock
{
"additionalProperties": true,
"properties": {
"content_block": {
"$ref": "#/components/schemas/Output_ResponseContentBlock"
},
"index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"index",
"content_block"
],
"type": "object"
}Output_ContentBlockStopEvent
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"index"
],
"type": "object"
}Output_ContentEmbedding
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"shape": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"values": {
"items": {
"type": "number"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_ContentPartEvent
Complete JSON Schema
Referenced structures: Output_Agent, Output_OutputContentPart
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content_index": {
"format": "int64",
"type": "integer"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"part": {
"$ref": "#/components/schemas/Output_OutputContentPart"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"part"
],
"type": "object"
}Output_ContextEditResponse
Complete JSON Schema
Referenced structures: Output_ClearedThinking, Output_ClearedTools
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ClearedTools"
},
{
"$ref": "#/components/schemas/Output_ClearedThinking"
}
]
}Output_ContextManagementCapability
Complete JSON Schema
Referenced structures: Output_CapabilitySupport
{
"additionalProperties": true,
"properties": {
"clear_thinking_20251015": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
{
"type": "null"
}
]
},
"clear_tool_uses_20250919": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
{
"type": "null"
}
]
},
"compact_20260112": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
{
"type": "null"
}
]
},
"supported": {
"type": "boolean"
}
},
"required": [
"clear_thinking_20251015",
"clear_tool_uses_20250919",
"compact_20260112",
"supported"
],
"type": "object"
}Output_ContextManagementResponse
Complete JSON Schema
Referenced structures: Output_ContextEditResponse
{
"additionalProperties": true,
"properties": {
"applied_edits": {
"items": {
"$ref": "#/components/schemas/Output_ContextEditResponse"
},
"type": "array"
}
},
"required": [
"applied_edits"
],
"type": "object"
}Output_ConversationCreatedEvent
Complete JSON Schema
Referenced structures: Output_ConversationCreatedEventConversation, Output_ConversationCreatedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_created_event.py`, `ConversationCreatedEvent`.",
"properties": {
"conversation": {
"$ref": "#/components/schemas/Output_ConversationCreatedEventConversation"
},
"event_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationCreatedEventType"
}
},
"required": [
"conversation",
"event_id",
"type"
],
"type": "object"
}Output_ConversationCreatedEventConversation
Complete JSON Schema
Referenced structures: Output_ConversationCreatedEventConversationObject
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_created_event.py`, `Conversation`.",
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConversationCreatedEventConversationObject"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ConversationCreatedEventConversationObject
Complete JSON Schema
{
"enum": [
"realtime.conversation"
],
"type": "string"
}Output_ConversationCreatedEventType
Complete JSON Schema
{
"enum": [
"conversation.created"
],
"type": "string"
}Output_ConversationItem
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemAssistantMessage, Output_RealtimeConversationItemFunctionCall, Output_RealtimeConversationItemFunctionCallOutput, Output_RealtimeConversationItemSystemMessage, Output_RealtimeConversationItemUserMessage, Output_RealtimeMcpApprovalRequest, Output_RealtimeMcpApprovalResponse, Output_RealtimeMcpListTools, Output_RealtimeMcpToolCall
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemSystemMessage"
},
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessage"
},
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemAssistantMessage"
},
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCall"
},
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCallOutput"
},
{
"$ref": "#/components/schemas/Output_RealtimeMcpApprovalResponse"
},
{
"$ref": "#/components/schemas/Output_RealtimeMcpListTools"
},
{
"$ref": "#/components/schemas/Output_RealtimeMcpToolCall"
},
{
"$ref": "#/components/schemas/Output_RealtimeMcpApprovalRequest"
}
],
"description": "Source: `openai/types/realtime/conversation_item.py`, `ConversationItem`."
}Output_ConversationItemAdded
Complete JSON Schema
Referenced structures: Output_ConversationItem, Output_ConversationItemAddedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_added.py`, `ConversationItemAdded`.",
"properties": {
"event_id": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/Output_ConversationItem"
},
"previous_item_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemAddedType"
}
},
"required": [
"event_id",
"item",
"type"
],
"type": "object"
}Output_ConversationItemAddedType
Complete JSON Schema
{
"enum": [
"conversation.item.added"
],
"type": "string"
}Output_ConversationItemCreatedEvent
Complete JSON Schema
Referenced structures: Output_ConversationItem, Output_ConversationItemCreatedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_created_event.py`, `ConversationItemCreatedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/Output_ConversationItem"
},
"previous_item_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemCreatedEventType"
}
},
"required": [
"event_id",
"item",
"type"
],
"type": "object"
}Output_ConversationItemCreatedEventType
Complete JSON Schema
{
"enum": [
"conversation.item.created"
],
"type": "string"
}Output_ConversationItemDeletedEvent
Complete JSON Schema
Referenced structures: Output_ConversationItemDeletedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_deleted_event.py`, `ConversationItemDeletedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemDeletedEventType"
}
},
"required": [
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_ConversationItemDeletedEventType
Complete JSON Schema
{
"enum": [
"conversation.item.deleted"
],
"type": "string"
}Output_ConversationItemDone
Complete JSON Schema
Referenced structures: Output_ConversationItem, Output_ConversationItemDoneType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_done.py`, `ConversationItemDone`.",
"properties": {
"event_id": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/Output_ConversationItem"
},
"previous_item_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemDoneType"
}
},
"required": [
"event_id",
"item",
"type"
],
"type": "object"
}Output_ConversationItemDoneType
Complete JSON Schema
{
"enum": [
"conversation.item.done"
],
"type": "string"
}Output_ConversationItemInputAudioTranscriptionCompletedEvent
Complete JSON Schema
Referenced structures: Output_ConversationItemInputAudioTranscriptionCompletedEventType, Output_ConversationItemInputAudioTranscriptionCompletedEventUsage, Output_LogProbProperties, Output_TranscriptionLanguage2
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_completed_event.py`, `ConversationItemInputAudioTranscriptionCompletedEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"languages": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionLanguage2"
},
"type": [
"array",
"null"
]
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_LogProbProperties"
},
"type": [
"array",
"null"
]
},
"transcript": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEventType"
},
"usage": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEventUsage"
}
},
"required": [
"content_index",
"event_id",
"item_id",
"transcript",
"type",
"usage"
],
"type": "object"
}Output_ConversationItemInputAudioTranscriptionCompletedEventType
Complete JSON Schema
{
"enum": [
"conversation.item.input_audio_transcription.completed"
],
"type": "string"
}Output_ConversationItemInputAudioTranscriptionCompletedEventUsage
Complete JSON Schema
Referenced structures: Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageDuration, Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokens
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokens"
},
{
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageDuration"
}
],
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_completed_event.py`, `Usage`."
}Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageDuration
Complete JSON Schema
Referenced structures: Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageDurationType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_completed_event.py`, `UsageTranscriptTextUsageDuration`.",
"properties": {
"seconds": {
"type": "number"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageDurationType"
}
},
"required": [
"seconds",
"type"
],
"type": "object"
}Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageDurationType
Complete JSON Schema
{
"enum": [
"duration"
],
"type": "string"
}Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokens
Complete JSON Schema
Referenced structures: Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokensInputTokenDetails, Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokensType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_completed_event.py`, `UsageTranscriptTextUsageTokens`.",
"properties": {
"input_token_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokensInputTokenDetails"
},
{
"type": "null"
}
]
},
"input_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"total_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokensType"
}
},
"required": [
"input_tokens",
"output_tokens",
"total_tokens",
"type"
],
"type": "object"
}Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokensInputTokenDetails
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_completed_event.py`, `UsageTranscriptTextUsageTokensInputTokenDetails`.",
"properties": {
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_ConversationItemInputAudioTranscriptionCompletedEventUsageTranscriptTextUsageTokensType
Complete JSON Schema
{
"enum": [
"tokens"
],
"type": "string"
}Output_ConversationItemInputAudioTranscriptionDeltaEvent
Complete JSON Schema
Referenced structures: Output_ConversationItemInputAudioTranscriptionDeltaEventType, Output_LogProbProperties
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_delta_event.py`, `ConversationItemInputAudioTranscriptionDeltaEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"delta": {
"type": [
"string",
"null"
]
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_LogProbProperties"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionDeltaEventType"
}
},
"required": [
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_ConversationItemInputAudioTranscriptionDeltaEventType
Complete JSON Schema
{
"enum": [
"conversation.item.input_audio_transcription.delta"
],
"type": "string"
}Output_ConversationItemInputAudioTranscriptionFailedEvent
Complete JSON Schema
Referenced structures: Output_ConversationItemInputAudioTranscriptionFailedEventError, Output_ConversationItemInputAudioTranscriptionFailedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_failed_event.py`, `ConversationItemInputAudioTranscriptionFailedEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"error": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionFailedEventError"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionFailedEventType"
}
},
"required": [
"content_index",
"error",
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_ConversationItemInputAudioTranscriptionFailedEventError
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_failed_event.py`, `Error`.",
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
},
"param": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ConversationItemInputAudioTranscriptionFailedEventType
Complete JSON Schema
{
"enum": [
"conversation.item.input_audio_transcription.failed"
],
"type": "string"
}Output_ConversationItemInputAudioTranscriptionSegment
Complete JSON Schema
Referenced structures: Output_ConversationItemInputAudioTranscriptionSegmentType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_input_audio_transcription_segment.py`, `ConversationItemInputAudioTranscriptionSegment`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"end": {
"type": "number"
},
"event_id": {
"type": "string"
},
"id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"speaker": {
"type": "string"
},
"start": {
"type": "number"
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionSegmentType"
}
},
"required": [
"id",
"content_index",
"end",
"event_id",
"item_id",
"speaker",
"start",
"text",
"type"
],
"type": "object"
}Output_ConversationItemInputAudioTranscriptionSegmentType
Complete JSON Schema
{
"enum": [
"conversation.item.input_audio_transcription.segment"
],
"type": "string"
}Output_ConversationItemRetrieved
Complete JSON Schema
Referenced structures: Output_ConversationItem, Output_ConversationItemRetrievedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_server_event.py`, `ConversationItemRetrieved`.",
"properties": {
"event_id": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/Output_ConversationItem"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemRetrievedType"
}
},
"required": [
"event_id",
"item",
"type"
],
"type": "object"
}Output_ConversationItemRetrievedType
Complete JSON Schema
{
"enum": [
"conversation.item.retrieved"
],
"type": "string"
}Output_ConversationItemTruncatedEvent
Complete JSON Schema
Referenced structures: Output_ConversationItemTruncatedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/conversation_item_truncated_event.py`, `ConversationItemTruncatedEvent`.",
"properties": {
"audio_end_ms": {
"format": "int64",
"type": "integer"
},
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ConversationItemTruncatedEventType"
}
},
"required": [
"audio_end_ms",
"content_index",
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_ConversationItemTruncatedEventType
Complete JSON Schema
{
"enum": [
"conversation.item.truncated"
],
"type": "string"
}Output_ConversationObject
Complete JSON Schema
{
"enum": [
"conversation"
],
"type": "string"
}Output_ConversationResponseBody
Complete JSON Schema
Referenced structures: Output_ConversationObject
{
"additionalProperties": true,
"properties": {
"created_at": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"metadata": true,
"object": {
"$ref": "#/components/schemas/Output_ConversationObject"
}
},
"required": [
"id",
"created_at",
"metadata",
"object"
],
"type": "object"
}Output_Coordinate
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"x",
"y"
],
"type": "object"
}Output_CountTokensContextManagementResponse
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"original_input_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"original_input_tokens"
],
"type": "object"
}Output_CountTokensObject
Complete JSON Schema
{
"enum": [
"response.input_tokens"
],
"type": "string"
}Output_CountTokensResponseBody
Complete JSON Schema
Referenced structures: Output_CountTokensObject
{
"additionalProperties": true,
"properties": {
"input_tokens": {
"format": "int64",
"type": "integer"
},
"object": {
"$ref": "#/components/schemas/Output_CountTokensObject"
}
},
"required": [
"input_tokens",
"object"
],
"type": "object"
}Output_CountTokensResponseBody2
Complete JSON Schema
Referenced structures: Output_CountTokensContextManagementResponse
{
"additionalProperties": true,
"properties": {
"context_management": {
"$ref": "#/components/schemas/Output_CountTokensContextManagementResponse"
},
"input_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"context_management",
"input_tokens"
],
"type": "object"
}Output_CountTokensResponseBody3
Complete JSON Schema
Referenced structures: Output_ModalityTokenCount
{
"additionalProperties": true,
"properties": {
"cacheTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"cachedContentTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"promptTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"totalTokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_CreateDecisionResponseBody
Complete JSON Schema
Referenced structures: Output_DecisionAnswer, Output_ResponseUsage
{
"additionalProperties": true,
"properties": {
"answers": {
"items": {
"$ref": "#/components/schemas/Output_DecisionAnswer"
},
"type": "array"
},
"model": {
"type": "string"
},
"usage": {
"$ref": "#/components/schemas/Output_ResponseUsage"
}
},
"required": [
"model",
"answers",
"usage"
],
"type": "object"
}Output_CreateEmbeddingResponseBody
Complete JSON Schema
Referenced structures: Output_EmbeddingListObject, Output_EmbeddingUsage, Output_OpenAiEmbedding
{
"additionalProperties": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Output_OpenAiEmbedding"
},
"type": "array"
},
"model": {
"type": "string"
},
"object": {
"$ref": "#/components/schemas/Output_EmbeddingListObject"
},
"usage": {
"$ref": "#/components/schemas/Output_EmbeddingUsage"
}
},
"required": [
"data",
"model",
"object",
"usage"
],
"type": "object"
}Output_CreateLiveSessionResponseBody
Complete JSON Schema
Referenced structures: Output_LiveResponseTransport, Output_LiveSessionId
{
"additionalProperties": true,
"properties": {
"session": {
"$ref": "#/components/schemas/Output_LiveSessionId"
},
"transport": {
"$ref": "#/components/schemas/Output_LiveResponseTransport"
}
},
"required": [
"session",
"transport"
],
"type": "object"
}Output_CreateModerationResponseBody
Complete JSON Schema
Referenced structures: Output_ModerationResult2
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"model": {
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Output_ModerationResult2"
},
"type": "array"
}
},
"required": [
"id",
"model",
"results"
],
"type": "object"
}Output_CreateRealtimeClientSecretResponseBody
Complete JSON Schema
Referenced structures: Output_ClientSecretResponseSession
{
"additionalProperties": true,
"properties": {
"expires_at": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"session": {
"$ref": "#/components/schemas/Output_ClientSecretResponseSession"
},
"value": {
"type": "string"
}
},
"required": [
"value",
"expires_at",
"session"
],
"type": "object"
}Output_CredentialBlockDto
Complete JSON Schema
{
"properties": {
"credentialId": {
"type": "string"
},
"id": {
"type": "string"
},
"observedAtMs": {
"format": "int64",
"type": "integer"
},
"operation": {
"type": [
"string",
"null"
]
},
"scope": true,
"source": true,
"untilMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"credentialId",
"scope",
"operation",
"untilMs",
"source",
"observedAtMs"
],
"type": "object"
}Output_CredentialCreated
Complete JSON Schema
{
"description": "A login that produced a credential row. The secret is already sealed in the\ndatabase; nothing about it travels back.",
"properties": {
"credentialId": {
"type": "string"
}
},
"required": [
"credentialId"
],
"type": "object"
}Output_CredentialCycleDto
Complete JSON Schema
Referenced structures: Output_CycleSampleDto
{
"description": "One period of one upstream window on a credential, with the USD this\ndeployment settled against it.",
"properties": {
"boundary": {
"description": "`local` (derived here, a guess) or `observed` (reported upstream).",
"type": "string"
},
"closedAtMs": {
"description": "None while the cycle is open.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"costUsd": {
"description": "USD settled against the cycle through this deployment. Final once\nclosed.",
"type": "string"
},
"credentialId": {
"type": "string"
},
"dimensionId": {
"type": [
"string",
"null"
]
},
"endsAtMs": {
"description": "None for a window that never ends.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"estimatedAllowanceUsd": {
"description": "`sample.costUsd / sample.usedPercent * 100`: the USD the whole window\nwould hold at the rate this cycle has been spending, when the sample\nreports a positive percent. It only sees traffic through this\ndeployment, so use elsewhere on the same account reads it low.",
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"openedBy": {
"description": "`first_use`, `rollover`, `server_reset` or `manual_reset`.",
"type": "string"
},
"sample": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CycleSampleDto"
},
{
"type": "null"
}
],
"description": "The latest upstream reading on the cycle; for a closed cycle, the\nlast one before it closed."
},
"scope": true,
"startsAtMs": {
"format": "int64",
"type": "integer"
},
"windowId": {
"description": "The observed `QuotaEntry.id`, the declared dimension id before any\nobservation, or `month` for a credential that declares no window.",
"type": "string"
}
},
"required": [
"id",
"credentialId",
"windowId",
"dimensionId",
"scope",
"startsAtMs",
"endsAtMs",
"boundary",
"openedBy",
"closedAtMs",
"costUsd",
"sample",
"estimatedAllowanceUsd"
],
"type": "object"
}Output_CredentialDto
Complete JSON Schema
{
"description": "A credential without its secret. Only presence and expiry timestamps are\nexposed; reading the material itself requires `Credentials::reveal_secret`.",
"properties": {
"authKind": {
"type": "string"
},
"connectionProfileId": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"hasSecret": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"metadata": true,
"organizationId": {
"description": "Opaque to this crate: the application layer decides what owns what.",
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
},
"proxy": {
"default": null
},
"refreshExpiresAtMs": {
"description": "Read-only refresh-token expiry, projected from the sealed secret on management reads.\nNone means no expiry was reported or the secret could not be read.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"status": {
"description": "`active` or `dead`.",
"type": "string"
},
"statusReason": {
"type": [
"string",
"null"
]
},
"teamId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"version": {
"description": "Bumped by every secret or lifecycle write; peers reload on a change.",
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"providerId",
"organizationId",
"teamId",
"userId",
"label",
"authKind",
"hasSecret",
"version",
"connectionProfileId",
"proxy",
"metadata",
"expiresAtMs",
"refreshExpiresAtMs",
"status",
"statusReason",
"enabled"
],
"type": "object"
}Output_CredentialLimitStatusDto
Complete JSON Schema
{
"description": "An operator limit's current window on one credential.",
"properties": {
"limit": {
"type": "string"
},
"metric": {
"type": "string"
},
"modelPattern": {
"type": [
"string",
"null"
]
},
"ownerId": {
"type": "string"
},
"ownerKind": {
"type": "string"
},
"period": {
"type": "string"
},
"quotaId": {
"type": "string"
},
"unit": {
"type": "string"
},
"used": {
"type": "string"
},
"windowEndMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"windowKey": {
"type": "string"
},
"windowStartMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"quotaId",
"ownerKind",
"ownerId",
"windowKey",
"metric",
"period",
"modelPattern",
"unit",
"limit",
"used",
"windowStartMs",
"windowEndMs"
],
"type": "object"
}Output_CredentialOwnerOptionDto
Complete JSON Schema
{
"properties": {
"id": {
"type": "string"
},
"kind": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"kind",
"id",
"name"
],
"type": "object"
}Output_CredentialProviderDto
Complete JSON Schema
Referenced structures: Output_ChannelCapabilities, Output_LoginMode
{
"properties": {
"capabilities": {
"$ref": "#/components/schemas/Output_ChannelCapabilities"
},
"channel": {
"type": "string"
},
"credentialKinds": {
"items": {
"type": "string"
},
"type": "array"
},
"displayName": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"loginModes": {
"items": {
"$ref": "#/components/schemas/Output_LoginMode"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"displayName",
"channel",
"enabled",
"credentialKinds",
"loginModes",
"capabilities"
],
"type": "object"
}Output_CredentialQuotaDto
Complete JSON Schema
Referenced structures: Output_CredentialBlockDto, Output_CredentialCycleDto
{
"description": "What this instance knows about one credential's upstream quota: its\ncycles — every open one and each window's most recent closed ones — and\nthe blocks currently keeping it out of selection.\n\nWindows overlap (a 5-hour and a weekly window both count the same\nrequest), so the cycles' costs are never meant to be summed across\nwindows. The raw readings behind the cycles are a separate, paged read.",
"properties": {
"blocks": {
"description": "Only blocks that have not expired yet.",
"items": {
"$ref": "#/components/schemas/Output_CredentialBlockDto"
},
"type": "array"
},
"cycles": {
"description": "Open cycles first, by window; then closed ones by window, newest\nfirst.",
"items": {
"$ref": "#/components/schemas/Output_CredentialCycleDto"
},
"type": "array"
}
},
"required": [
"cycles",
"blocks"
],
"type": "object"
}Output_CredentialSummaryDto
Complete JSON Schema
{
"description": "What a refresh reports back: never secret material, only its identity.",
"properties": {
"credentialId": {
"type": "string"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"status": {
"type": "string"
},
"statusReason": {
"type": [
"string",
"null"
]
},
"version": {
"format": "int64",
"type": "integer"
}
},
"required": [
"credentialId",
"version",
"expiresAtMs",
"status",
"statusReason"
],
"type": "object"
}Output_CustomCall
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"input": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"input",
"name"
],
"type": "object"
}Output_CustomMetadata
Complete JSON Schema
Referenced structures: Output_StringList
{
"additionalProperties": true,
"properties": {
"key": {
"type": [
"string",
"null"
]
},
"numericValue": {
"format": "double",
"type": [
"number",
"null"
]
},
"stringListValue": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_StringList"
},
{
"type": "null"
}
]
},
"stringValue": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_CustomOutput
Complete JSON Schema
Referenced structures: Output_InputContent
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Output_InputContent"
},
"type": "array"
}
]
}Output_CustomTextFormat
Complete JSON Schema
Referenced structures: Output_TextFormatType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_TextFormatType"
}
},
"required": [
"type"
],
"type": "object"
}Output_CustomTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller, Output_CustomToolFormat
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CustomToolFormat"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Output_CustomToolCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_CustomToolCallType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"input": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_CustomToolCallType"
}
},
"required": [
"type",
"call_id",
"input",
"name"
],
"type": "object"
}Output_CustomToolCall2
Complete JSON Schema
Referenced structures: Output_CustomCall, Output_CustomToolCallType2
{
"additionalProperties": true,
"properties": {
"custom": {
"$ref": "#/components/schemas/Output_CustomCall"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_CustomToolCallType2"
}
},
"required": [
"id",
"custom",
"type"
],
"type": "object"
}Output_CustomToolCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_CustomOutput, Output_CustomToolCallOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Output_CustomOutput"
},
"type": {
"$ref": "#/components/schemas/Output_CustomToolCallOutputType"
}
},
"required": [
"type",
"call_id",
"output"
],
"type": "object"
}Output_CustomToolCallOutputType
Complete JSON Schema
{
"enum": [
"custom_tool_call_output"
],
"type": "string"
}Output_CustomToolCallType
Complete JSON Schema
{
"enum": [
"custom_tool_call"
],
"type": "string"
}Output_CustomToolCallType2
Complete JSON Schema
{
"enum": [
"custom"
],
"type": "string"
}Output_CustomToolFormat
Complete JSON Schema
Referenced structures: Output_CustomTextFormat, Output_GrammarFormat
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_CustomTextFormat"
},
{
"$ref": "#/components/schemas/Output_GrammarFormat"
}
]
}Output_CustomToolInputDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"delta"
],
"type": "object"
}Output_CustomToolInputDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"input": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"input"
],
"type": "object"
}Output_CustomVoice
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Output_CyberAccessProgram
Complete JSON Schema
{
"enum": [
"standard",
"daybreak_blue",
"daybreak_red"
],
"type": "string"
}Output_CyberAccessProgram2
Complete JSON Schema
{
"enum": [
"standard",
"daybreak_blue",
"daybreak_red"
],
"type": "string"
}Output_CycleSampleDto
Complete JSON Schema
{
"description": "One upstream reading, kept on a cycle as a set taken at `atMs`.",
"properties": {
"atMs": {
"format": "int64",
"type": "integer"
},
"costUsd": {
"description": "The cycle's `costUsd` when the reading was taken.",
"type": [
"string",
"null"
]
},
"limit": {
"type": [
"string",
"null"
]
},
"used": {
"type": [
"string",
"null"
]
},
"usedPercent": {
"description": "On the 0..100 scale.",
"type": [
"string",
"null"
]
}
},
"required": [
"usedPercent",
"used",
"limit",
"costUsd",
"atMs"
],
"type": "object"
}Output_DecisionAnswer
Complete JSON Schema
Referenced structures: Output_DecisionChoiceProbability, Output_DecisionChoiceValue, Output_DecisionScoreProbability
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"probability": {
"format": "double",
"type": "number"
},
"type": {
"const": "predicate",
"type": "string"
}
},
"required": [
"type",
"probability"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"choice": {
"$ref": "#/components/schemas/Output_DecisionChoiceValue"
},
"confidence": {
"format": "double",
"type": "number"
},
"name": {
"type": [
"string",
"null"
]
},
"probabilities": {
"items": {
"$ref": "#/components/schemas/Output_DecisionChoiceProbability"
},
"type": "array"
},
"type": {
"const": "choice",
"type": "string"
}
},
"required": [
"type",
"choice",
"confidence",
"probabilities"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"confidence": {
"format": "double",
"type": "number"
},
"name": {
"type": [
"string",
"null"
]
},
"probabilities": {
"items": {
"$ref": "#/components/schemas/Output_DecisionScoreProbability"
},
"type": "array"
},
"score": {
"format": "double",
"type": "number"
},
"type": {
"const": "score",
"type": "string"
}
},
"required": [
"type",
"score",
"confidence",
"probabilities"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"type": {
"const": "refusal",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_DecisionChoice
Complete JSON Schema
Referenced structures: Output_DecisionChoiceValue
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"value": {
"$ref": "#/components/schemas/Output_DecisionChoiceValue"
}
},
"required": [
"value"
],
"type": "object"
}Output_DecisionChoiceProbability
Complete JSON Schema
Referenced structures: Output_DecisionChoiceValue
{
"additionalProperties": true,
"properties": {
"probability": {
"format": "double",
"type": "number"
},
"value": {
"$ref": "#/components/schemas/Output_DecisionChoiceValue"
}
},
"required": [
"value",
"probability"
],
"type": "object"
}Output_DecisionChoiceValue
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"type": "boolean"
}
]
}Output_DecisionQuestion
Complete JSON Schema
Referenced structures: Output_DecisionChoice, Output_DecisionScoreLevel
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"const": "predicate",
"type": "string"
}
},
"required": [
"type",
"instructions"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"choices": {
"items": {
"$ref": "#/components/schemas/Output_DecisionChoice"
},
"type": "array"
},
"instructions": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"const": "choice",
"type": "string"
}
},
"required": [
"type",
"instructions",
"choices"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": "string"
},
"levels": {
"items": {
"$ref": "#/components/schemas/Output_DecisionScoreLevel"
},
"type": "array"
},
"name": {
"type": [
"string",
"null"
]
},
"type": {
"const": "score",
"type": "string"
}
},
"required": [
"type",
"instructions",
"levels"
],
"type": "object"
}
]
}Output_DecisionScoreLevel
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"label": {
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
}Output_DecisionScoreProbability
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"label": {
"type": "string"
},
"probability": {
"format": "double",
"type": "number"
},
"value": {
"format": "int64",
"type": "integer"
}
},
"required": [
"label",
"value",
"probability"
],
"type": "object"
}Output_DefaultModelCatalogDto
Complete JSON Schema
Referenced structures: Output_DefaultModelCatalogSourceDto, Output_DefaultModelDto
{
"description": "The bundled catalog, exactly as the asset spells it. Its numbers are\nchecked against its own rows at load: a truncated asset is a build problem\nand should be found once, not per lookup.",
"properties": {
"models": {
"items": {
"$ref": "#/components/schemas/Output_DefaultModelDto"
},
"type": "array"
},
"schemaVersion": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"source": {
"$ref": "#/components/schemas/Output_DefaultModelCatalogSourceDto"
}
},
"required": [
"schemaVersion",
"source",
"models"
],
"type": "object"
}Output_DefaultModelCatalogSourceDto
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"catalog": {
"type": "string"
},
"fetchedAt": {
"type": "string"
},
"pricedModels": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"totalModels": {
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"catalog",
"fetchedAt",
"totalModels",
"pricedModels"
],
"type": "object"
}Output_DefaultModelDto
Complete JSON Schema
Referenced structures: Output_DefaultModelPricingDto
{
"additionalProperties": true,
"description": "One catalog entry. `model_id` is the unqualified model name; the\nunmodelled keys — modalities, supported parameters, reasoning levels — stay\nin `metadata`, which is exactly the shape the `models.metadata` column\nholds.",
"properties": {
"contextWindow": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"displayName": {
"default": null,
"type": [
"string",
"null"
]
},
"maxOutputTokens": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"modelId": {
"type": "string"
},
"pricing": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DefaultModelPricingDto"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"modelId",
"displayName",
"contextWindow",
"maxOutputTokens",
"pricing"
],
"type": "object"
}Output_DefaultModelPriceRateDto
Complete JSON Schema
{
"properties": {
"conditions": {
"default": null
},
"metric": {
"type": "string"
},
"price": {
"description": "A decimal string: this is money and must not pass through a float.",
"type": "string"
},
"priority": {
"format": "int64",
"type": "integer"
},
"unitSize": {
"description": "`1000000` for the token metrics, `1` for counted ones.",
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"conditions",
"metric",
"unitSize",
"price",
"priority"
],
"type": "object"
}Output_DefaultModelPricingDto
Complete JSON Schema
Referenced structures: Output_DefaultModelPriceRateDto, Output_DefaultModelTierDto
{
"description": "The price book for one model: a glob, its rates, and the context or\nservice-tier overrides above them.",
"properties": {
"modelPattern": {
"description": "A `*fragment*` glob. The longer the fragment, the more specific the\nrule, which is what `priority` encodes.",
"type": "string"
},
"priority": {
"format": "int64",
"type": "integer"
},
"rates": {
"items": {
"$ref": "#/components/schemas/Output_DefaultModelPriceRateDto"
},
"type": "array"
},
"tiers": {
"default": null,
"items": {
"$ref": "#/components/schemas/Output_DefaultModelTierDto"
},
"type": [
"array",
"null"
]
}
},
"required": [
"modelPattern",
"priority",
"rates",
"tiers"
],
"type": "object"
}Output_DefaultModelTierDto
Complete JSON Schema
Referenced structures: Output_CacheCreationPriceDto
{
"description": "A long-context or service-tier override. Every price is optional and every\nabsent one inherits the rule's rates.",
"properties": {
"audioInputPrice": {
"default": null,
"type": [
"string",
"null"
]
},
"audioOutputPrice": {
"default": null,
"type": [
"string",
"null"
]
},
"cacheCreationPerMillion": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_CacheCreationPriceDto"
},
"type": "array"
},
"cacheReadPrice": {
"default": null,
"type": [
"string",
"null"
]
},
"cachedAudioInputPrice": {
"default": null,
"type": [
"string",
"null"
]
},
"imageOutputPrice": {
"default": null,
"type": [
"string",
"null"
]
},
"inputPrice": {
"default": null,
"type": [
"string",
"null"
]
},
"minPromptTokens": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"multiplier": {
"default": null,
"type": [
"string",
"null"
]
},
"outputPrice": {
"default": null,
"type": [
"string",
"null"
]
},
"serviceTier": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"serviceTier",
"minPromptTokens",
"multiplier",
"inputPrice",
"outputPrice",
"cacheReadPrice",
"cacheCreationPerMillion",
"imageOutputPrice",
"audioInputPrice",
"audioOutputPrice",
"cachedAudioInputPrice"
],
"type": "object"
}Output_DeleteFileResponseBody
Complete JSON Schema
Referenced structures: Output_DeletedFileObject
{
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
},
"object": {
"$ref": "#/components/schemas/Output_DeletedFileObject"
}
},
"required": [
"id",
"object",
"deleted"
],
"type": "object"
}Output_DeleteFileResponseBody2
Complete JSON Schema
Referenced structures: Output_DeletedFileType
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DeletedFileType"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"type": "object"
}Output_DeleteFileResponseBody3
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_DeletedFileObject
Complete JSON Schema
{
"enum": [
"file"
],
"type": "string"
}Output_DeletedFileType
Complete JSON Schema
{
"enum": [
"file_deleted"
],
"type": "string"
}Output_Delta
Complete JSON Schema
Referenced structures: Output_DeltaFunctionCall, Output_DeltaRole, Output_DeltaToolCall, Output_ReasoningDetail
{
"additionalProperties": true,
"properties": {
"content": {
"type": [
"string",
"null"
]
},
"function_call": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DeltaFunctionCall"
},
{
"type": "null"
}
]
},
"reasoning": {
"description": "Alternative compatible-provider spelling. Kept separately on the wire.",
"type": [
"string",
"null"
]
},
"reasoning_content": {
"description": "Plain-text reasoning returned by compatible providers (for example DeepSeek).",
"type": [
"string",
"null"
]
},
"reasoning_details": {
"items": {
"$ref": "#/components/schemas/Output_ReasoningDetail"
},
"type": [
"array",
"null"
]
},
"refusal": {
"type": [
"string",
"null"
]
},
"role": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DeltaRole"
},
{
"type": "null"
}
]
},
"tool_calls": {
"items": {
"$ref": "#/components/schemas/Output_DeltaToolCall"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_DeltaFunctionCall
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"arguments": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_DeltaRole
Complete JSON Schema
{
"enum": [
"developer",
"system",
"user",
"tool",
"assistant"
],
"type": "string"
}Output_DeltaToolCall
Complete JSON Schema
Referenced structures: Output_DeltaFunctionCall, Output_DeltaToolCallType
{
"additionalProperties": true,
"properties": {
"function": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DeltaFunctionCall"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"index": {
"format": "int64",
"type": "integer"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DeltaToolCallType"
},
{
"type": "null"
}
]
}
},
"required": [
"index"
],
"type": "object"
}Output_DeltaToolCallType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Output_DeviceCodeResponse
Complete JSON Schema
{
"description": "RFC 8628 §3.2. `device_code` is plaintext and exists only here.",
"properties": {
"device_code": {
"description": "The secret the device polls with.",
"type": "string"
},
"expires_in": {
"description": "Seconds.",
"format": "int64",
"type": "integer"
},
"interval": {
"description": "The minimum seconds between polls.",
"format": "int64",
"type": "integer"
},
"user_code": {
"description": "The short code the person types, in the grouped form they read off the\nscreen. Lookups normalize it, so any spelling with the right characters\nresolves.",
"type": "string"
},
"verification_uri": {
"type": "string"
},
"verification_uri_complete": {
"description": "The same page with the code already filled in, for a device that can\nshow a QR code (RFC 8628 §3.3.1).",
"type": "string"
}
},
"required": [
"device_code",
"user_code",
"verification_uri",
"verification_uri_complete",
"expires_in",
"interval"
],
"type": "object"
}Output_DeviceDecided
Complete JSON Schema
{
"description": "The outcome of an approval-page decision or a cancellation.",
"properties": {
"approved": {
"type": "boolean"
},
"user_code": {
"type": "string"
}
},
"required": [
"user_code",
"approved"
],
"type": "object"
}Output_DeviceDetails
Complete JSON Schema
{
"description": "What the approval page renders for a pending device authorization.",
"properties": {
"client_id": {
"type": "string"
},
"client_name": {
"type": "string"
},
"expires_at_ms": {
"description": "Milliseconds, unlike the RFC fields above: this one is for a page this\nrepository renders, not for the device.",
"format": "int64",
"type": "integer"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"user_code": {
"description": "The normalized code, as stored.",
"type": "string"
}
},
"required": [
"client_id",
"client_name",
"user_code",
"scopes",
"expires_at_ms"
],
"type": "object"
}Output_DevicePollOutcome
Complete JSON Schema
{
"description": "One polling step. The SDK never sleeps and never loops: the caller owns the\ncadence, and `interval_secs` is what it should honour.",
"oneOf": [
{
"description": "Nobody has approved it yet. Poll again after `interval_secs`.",
"properties": {
"intervalSecs": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"status": {
"const": "pending",
"type": "string"
}
},
"required": [
"status",
"intervalSecs"
],
"type": "object"
},
{
"properties": {
"credentialId": {
"type": "string"
},
"status": {
"const": "ready",
"type": "string"
}
},
"required": [
"status",
"credentialId"
],
"type": "object"
},
{
"description": "The person refused. The session is gone; starting again is the only way\nforward.",
"properties": {
"status": {
"const": "denied",
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
{
"description": "The user code outlived its window. The session is gone.",
"properties": {
"status": {
"const": "expired",
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
}
]
}Output_DeviceStarted
Complete JSON Schema
{
"properties": {
"expiresAtMs": {
"description": "When the upstream stops accepting this user code, if it said.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"intervalSecs": {
"description": "How long to wait before the first poll, and between polls. The upstream\nmay raise it; a `Pending` answer always carries the current value.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"loginSessionId": {
"type": "string"
},
"userCode": {
"description": "What the person types on the other device.",
"type": "string"
},
"verificationUri": {
"type": "string"
},
"verificationUriComplete": {
"description": "The same page with the code already filled in, where the upstream\noffers one.",
"type": [
"string",
"null"
]
}
},
"required": [
"loginSessionId",
"userCode",
"verificationUri",
"verificationUriComplete",
"intervalSecs",
"expiresAtMs"
],
"type": "object"
}Output_DiagnosticOutcome
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_DiagnosticsResponse
Complete JSON Schema
Referenced structures: Output_CacheMissReason2
{
"additionalProperties": true,
"properties": {
"cache_miss_reason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheMissReason2"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_DirectCaller
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_DirectCaller2
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_DiscoveredModelDto
Complete JSON Schema
{
"description": "One model an upstream says it offers.",
"properties": {
"hasDefaultPrice": {
"description": "Whether the bundled catalog can price it without an operator writing a\nrule by hand.",
"type": "boolean"
},
"hasPrice": {
"description": "A saved provider or global rule matches this upstream model.",
"type": [
"boolean",
"null"
]
},
"known": {
"description": "Whether this provider already has a `provider_models` row for it.",
"type": "boolean"
},
"metadata": true,
"upstreamName": {
"type": "string"
}
},
"required": [
"upstreamName",
"known",
"hasDefaultPrice",
"metadata"
],
"type": "object"
}Output_DomainSecret
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"domain": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"domain",
"name",
"value"
],
"type": "object"
}Output_DoubleClickAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"x",
"y",
"keys"
],
"type": "object"
}Output_DragAction
Complete JSON Schema
Referenced structures: Output_Coordinate
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"path": {
"items": {
"$ref": "#/components/schemas/Output_Coordinate"
},
"type": "array"
}
},
"required": [
"path"
],
"type": "object"
}Output_DurationUsageType
Complete JSON Schema
{
"enum": [
"duration"
],
"type": "string"
}Output_EasyInputMessage
Complete JSON Schema
Referenced structures: Output_Agent, Output_MessageContent, Output_MessagePhase, Output_MessageRole, Output_MessageType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Output_MessageContent"
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MessagePhase"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Output_MessageRole"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MessageType"
},
{
"type": "null"
}
]
}
},
"required": [
"content",
"role"
],
"type": "object"
}Output_EffortCapability
Complete JSON Schema
Referenced structures: Output_CapabilitySupport
{
"additionalProperties": true,
"properties": {
"high": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"low": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"max": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"medium": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"supported": {
"type": "boolean"
},
"xhigh": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
{
"type": "null"
}
]
}
},
"required": [
"high",
"low",
"max",
"medium",
"supported",
"xhigh"
],
"type": "object"
}Output_EmbedContentResponseBody
Complete JSON Schema
Referenced structures: Output_ContentEmbedding, Output_EmbeddingUsageMetadata
{
"additionalProperties": true,
"properties": {
"embedding": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ContentEmbedding"
},
{
"type": "null"
}
]
},
"usageMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_EmbeddingUsageMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_EmbeddingListObject
Complete JSON Schema
{
"enum": [
"list"
],
"type": "string"
}Output_EmbeddingObject
Complete JSON Schema
{
"enum": [
"embedding"
],
"type": "string"
}Output_EmbeddingUsage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"prompt_tokens": {
"format": "int64",
"type": "integer"
},
"total_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"prompt_tokens",
"total_tokens"
],
"type": "object"
}Output_EmbeddingUsageMetadata
Complete JSON Schema
Referenced structures: Output_ModalityTokenCount
{
"additionalProperties": true,
"properties": {
"promptTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"promptTokenDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_EmbeddingVector
Complete JSON Schema
{
"anyOf": [
{
"items": {
"type": "number"
},
"type": "array"
},
{
"type": "string"
}
]
}Output_EncryptedCodeExecutionResult
Complete JSON Schema
Referenced structures: Output_CodeExecutionOutput, Output_EncryptedCodeExecutionResultType
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_CodeExecutionOutput"
},
"type": "array"
},
"encrypted_stdout": {
"type": "string"
},
"return_code": {
"format": "int64",
"type": "integer"
},
"stderr": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_EncryptedCodeExecutionResultType"
}
},
"required": [
"type",
"content",
"encrypted_stdout",
"return_code",
"stderr"
],
"type": "object"
}Output_EncryptedCodeExecutionResultType
Complete JSON Schema
{
"enum": [
"encrypted_code_execution_result"
],
"type": "string"
}Output_EncryptedContent
Complete JSON Schema
Referenced structures: Output_EncryptedContentType
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_EncryptedContentType"
}
},
"required": [
"type",
"encrypted_content"
],
"type": "object"
}Output_EncryptedContentType
Complete JSON Schema
{
"enum": [
"encrypted_content"
],
"type": "string"
}Output_Envelope
Complete JSON Schema
Referenced structures: Output_EnvelopeBody
{
"properties": {
"error": {
"$ref": "#/components/schemas/Output_EnvelopeBody"
}
},
"required": [
"error"
],
"type": "object"
}Output_EnvelopeBody
Complete JSON Schema
{
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
}Output_ErrorDetail
Complete JSON Schema
{
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"message": {
"type": "string"
},
"param": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
},
"required": [
"message"
],
"type": "object"
}Output_ErrorEvent
Complete JSON Schema
Referenced structures: Output_StreamError
{
"additionalProperties": true,
"properties": {
"error": {
"$ref": "#/components/schemas/Output_StreamError"
},
"request_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"error"
],
"type": "object"
}Output_ErrorMessage
Complete JSON Schema
Referenced structures: Output_ErrorDetail, Output_ErrorMessageType
{
"properties": {
"error": {
"$ref": "#/components/schemas/Output_ErrorDetail"
},
"status": {
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"stream_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ErrorMessageType"
}
},
"required": [
"type",
"error"
],
"type": "object"
}Output_ErrorMessageType
Complete JSON Schema
{
"enum": [
"error"
],
"type": "string"
}Output_ExecutableCode
Complete JSON Schema
Referenced structures: Output_Language
{
"additionalProperties": true,
"properties": {
"code": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"language": {
"$ref": "#/components/schemas/Output_Language"
}
},
"required": [
"language",
"code"
],
"type": "object"
}Output_ExportCredentialDto
Complete JSON Schema
Referenced structures: Output_SealedSecretDto
{
"description": "A credential row plus the sealed bytes behind it. The columns are flattened,\nso the object is a [`CredentialDto`] with one field added.",
"properties": {
"authKind": {
"type": "string"
},
"connectionProfileId": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"hasSecret": {
"type": "boolean"
},
"id": {
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"metadata": true,
"organizationId": {
"description": "Opaque to this crate: the application layer decides what owns what.",
"type": [
"string",
"null"
]
},
"providerId": {
"type": "string"
},
"proxy": {
"default": null
},
"refreshExpiresAtMs": {
"description": "Read-only refresh-token expiry, projected from the sealed secret on management reads.\nNone means no expiry was reported or the secret could not be read.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"secret": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SealedSecretDto"
},
{
"type": "null"
}
],
"default": null,
"description": "The database column verbatim; null when the export omitted secrets."
},
"status": {
"description": "`active` or `dead`.",
"type": "string"
},
"statusReason": {
"type": [
"string",
"null"
]
},
"teamId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
},
"version": {
"description": "Bumped by every secret or lifecycle write; peers reload on a change.",
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"providerId",
"organizationId",
"teamId",
"userId",
"label",
"authKind",
"hasSecret",
"version",
"connectionProfileId",
"proxy",
"metadata",
"expiresAtMs",
"refreshExpiresAtMs",
"status",
"statusReason",
"enabled",
"secret"
],
"type": "object"
}Output_FailedSteeringSubmission
Complete JSON Schema
Referenced structures: Output_SteerInput
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"input": {
"$ref": "#/components/schemas/Output_SteerInput"
},
"previous_response_id": {
"type": "string"
}
},
"required": [
"previous_response_id",
"input"
],
"type": "object"
}Output_FallbackCreditStatus
Complete JSON Schema
Referenced structures: Output_FallbackNotApplied, Output_FallbackRedeemed
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_FallbackRedeemed"
},
{
"$ref": "#/components/schemas/Output_FallbackNotApplied"
}
]
}Output_FallbackCreditUsage
Complete JSON Schema
Referenced structures: Output_FallbackCreditStatus
{
"additionalProperties": true,
"properties": {
"status": {
"$ref": "#/components/schemas/Output_FallbackCreditStatus"
}
},
"required": [
"status"
],
"type": "object"
}Output_FallbackInfo
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
}
},
"required": [
"model"
],
"type": "object"
}Output_FallbackMessageIterationUsage
Complete JSON Schema
Referenced structures: Output_CacheCreation, Output_FallbackMessageIterationUsageType
{
"additionalProperties": true,
"properties": {
"cache_creation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheCreation"
},
{
"type": "null"
}
]
},
"cache_creation_input_tokens": {
"format": "int64",
"type": "integer"
},
"cache_read_input_tokens": {
"format": "int64",
"type": "integer"
},
"input_tokens": {
"format": "int64",
"type": "integer"
},
"model": {
"type": "string"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_FallbackMessageIterationUsageType"
}
},
"required": [
"type",
"cache_creation_input_tokens",
"cache_read_input_tokens",
"input_tokens",
"model",
"output_tokens"
],
"type": "object"
}Output_FallbackMessageIterationUsageType
Complete JSON Schema
{
"enum": [
"fallback_message"
],
"type": "string"
}Output_FallbackNotApplied
Complete JSON Schema
Referenced structures: Output_FallbackNotAppliedReason, Output_FallbackNotAppliedType
{
"additionalProperties": true,
"properties": {
"reason": {
"$ref": "#/components/schemas/Output_FallbackNotAppliedReason"
},
"remove_to_redeem": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_FallbackNotAppliedType"
}
},
"required": [
"type",
"reason"
],
"type": "object"
}Output_FallbackNotAppliedReason
Complete JSON Schema
{
"enum": [
"body_mismatch",
"continuation_excluded",
"continuation_only",
"expired",
"invalid_target_model",
"not_enabled",
"reprice_unavailable",
"temporarily_unavailable",
"variant_fields_present",
"wrong_organization",
"wrong_platform",
"wrong_workspace"
],
"type": "string"
}Output_FallbackNotAppliedType
Complete JSON Schema
{
"enum": [
"not_applied"
],
"type": "string"
}Output_FallbackRedeemed
Complete JSON Schema
Referenced structures: Output_FallbackRedeemedType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_FallbackRedeemedType"
}
},
"required": [
"type"
],
"type": "object"
}Output_FallbackRedeemedType
Complete JSON Schema
{
"enum": [
"redeemed"
],
"type": "string"
}Output_FallbackRefusalTrigger
Complete JSON Schema
Referenced structures: Output_FallbackRefusalTriggerType, Output_RefusalCategory
{
"additionalProperties": true,
"properties": {
"category": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RefusalCategory"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_FallbackRefusalTriggerType"
}
},
"required": [
"type"
],
"type": "object"
}Output_FallbackRefusalTriggerType
Complete JSON Schema
{
"enum": [
"refusal"
],
"type": "string"
}Output_File
Complete JSON Schema
Referenced structures: Output_FileSize, Output_FileSource, Output_FileState, Output_Status, Output_VideoFileMetadata
{
"additionalProperties": true,
"properties": {
"createTime": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": [
"string",
"null"
]
},
"downloadUri": {
"type": [
"string",
"null"
]
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Status"
},
{
"type": "null"
}
]
},
"expirationTime": {
"type": [
"string",
"null"
]
},
"mimeType": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"sha256Hash": {
"type": [
"string",
"null"
]
},
"sizeBytes": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileSize"
},
{
"type": "null"
}
]
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileSource"
},
{
"type": "null"
}
]
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileState"
},
{
"type": "null"
}
]
},
"updateTime": {
"type": [
"string",
"null"
]
},
"uri": {
"type": [
"string",
"null"
]
},
"videoMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VideoFileMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_FileAttributeValue
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}Output_FileCitation
Complete JSON Schema
Referenced structures: Output_FileCitationType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"filename": {
"type": "string"
},
"index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_FileCitationType"
}
},
"required": [
"file_id",
"filename",
"index",
"type"
],
"type": "object"
}Output_FileCitationType
Complete JSON Schema
{
"enum": [
"file_citation"
],
"type": "string"
}Output_FileData
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"displayName": {
"type": [
"string",
"null"
]
},
"fileUri": {
"type": "string"
},
"mimeType": {
"type": [
"string",
"null"
]
}
},
"required": [
"fileUri"
],
"type": "object"
}Output_FileDetail
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high"
],
"type": "string"
}Output_FileMetadata
Complete JSON Schema
Referenced structures: Output_FileScope, Output_FileType
{
"additionalProperties": true,
"properties": {
"created_at": {
"type": "string"
},
"downloadable": {
"type": [
"boolean",
"null"
]
},
"expires_at": {
"type": [
"string",
"null"
]
},
"filename": {
"type": "string"
},
"id": {
"type": "string"
},
"mime_type": {
"type": "string"
},
"scope": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileScope"
},
{
"type": "null"
}
]
},
"size_bytes": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_FileType"
}
},
"required": [
"id",
"created_at",
"filename",
"mime_type",
"size_bytes",
"type"
],
"type": "object"
}Output_FileObject
Complete JSON Schema
Referenced structures: Output_FileObjectType, Output_FilePurpose, Output_FileStatus
{
"additionalProperties": true,
"properties": {
"bytes": {
"format": "int64",
"type": "integer"
},
"created_at": {
"format": "int64",
"type": "integer"
},
"expires_at": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"filename": {
"type": "string"
},
"id": {
"type": "string"
},
"object": {
"$ref": "#/components/schemas/Output_FileObjectType"
},
"purpose": {
"$ref": "#/components/schemas/Output_FilePurpose"
},
"status": {
"$ref": "#/components/schemas/Output_FileStatus"
},
"status_details": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"bytes",
"created_at",
"filename",
"object",
"purpose",
"status"
],
"type": "object"
}Output_FileObjectType
Complete JSON Schema
{
"enum": [
"file"
],
"type": "string"
}Output_FilePath
Complete JSON Schema
Referenced structures: Output_FilePathType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_FilePathType"
}
},
"required": [
"file_id",
"index",
"type"
],
"type": "object"
}Output_FilePathType
Complete JSON Schema
{
"enum": [
"file_path"
],
"type": "string"
}Output_FilePurpose
Complete JSON Schema
{
"enum": [
"assistants",
"batch",
"fine-tune",
"vision",
"user_data",
"assistants_output",
"batch_output",
"fine-tune-results"
],
"type": "string"
}Output_FileScope
Complete JSON Schema
Referenced structures: Output_FileScopeType
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_FileScopeType"
}
},
"required": [
"id",
"type"
],
"type": "object"
}Output_FileScopeType
Complete JSON Schema
{
"enum": [
"session"
],
"type": "string"
}Output_FileSearchCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_FileSearchCallType, Output_FileSearchResult, Output_FileSearchStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"queries": {
"items": {
"type": "string"
},
"type": "array"
},
"results": {
"items": {
"$ref": "#/components/schemas/Output_FileSearchResult"
},
"type": [
"array",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Output_FileSearchStatus"
},
"type": {
"$ref": "#/components/schemas/Output_FileSearchCallType"
}
},
"required": [
"type",
"id",
"queries",
"status"
],
"type": "object"
}Output_FileSearchCallType
Complete JSON Schema
{
"enum": [
"file_search_call"
],
"type": "string"
}Output_FileSearchFilter
Complete JSON Schema
Referenced structures: Output_ComparisonFilter, Output_CompoundFilter
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ComparisonFilter"
},
{
"$ref": "#/components/schemas/Output_CompoundFilter"
}
]
}Output_FileSearchResult
Complete JSON Schema
Referenced structures: Output_FileAttributeValue
{
"additionalProperties": true,
"properties": {
"attributes": {
"additionalProperties": {
"$ref": "#/components/schemas/Output_FileAttributeValue"
},
"type": [
"object",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"score": {
"type": [
"number",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_FileSearchStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"searching",
"completed",
"incomplete",
"failed"
],
"type": "string"
}Output_FileSearchTool
Complete JSON Schema
Referenced structures: Output_FileSearchFilter, Output_RankingOptions
{
"additionalProperties": true,
"properties": {
"filters": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileSearchFilter"
},
{
"type": "null"
}
]
},
"max_num_results": {
"type": [
"number",
"null"
]
},
"ranking_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RankingOptions"
},
{
"type": "null"
}
]
},
"vector_store_ids": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"vector_store_ids"
],
"type": "object"
}Output_FileSize
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"format": "int64",
"type": "integer"
}
],
"description": "ProtoJSON int64 values encode as strings; parsers also accept JSON integers."
}Output_FileSource
Complete JSON Schema
{
"enum": [
"SOURCE_UNSPECIFIED",
"UPLOADED",
"GENERATED",
"REGISTERED"
],
"type": "string"
}Output_FileState
Complete JSON Schema
{
"enum": [
"STATE_UNSPECIFIED",
"PROCESSING",
"ACTIVE",
"FAILED"
],
"type": "string"
}Output_FileStatus
Complete JSON Schema
{
"enum": [
"uploaded",
"processed",
"error"
],
"type": "string"
}Output_FileType
Complete JSON Schema
{
"enum": [
"file"
],
"type": "string"
}Output_FilterArrayValue
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}Output_FilterValue
Complete JSON Schema
Referenced structures: Output_FilterArrayValue
{
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"items": {
"$ref": "#/components/schemas/Output_FilterArrayValue"
},
"type": "array"
}
]
}Output_FinishReason
Complete JSON Schema
{
"oneOf": [
{
"enum": [
"FINISH_REASON_UNSPECIFIED",
"STOP",
"MAX_TOKENS",
"SAFETY",
"RECITATION",
"LANGUAGE",
"OTHER",
"BLOCKLIST",
"PROHIBITED_CONTENT",
"SPII",
"MALFORMED_FUNCTION_CALL",
"IMAGE_SAFETY",
"IMAGE_PROHIBITED_CONTENT",
"IMAGE_OTHER",
"NO_IMAGE",
"IMAGE_RECITATION",
"UNEXPECTED_TOOL_CALL",
"TOO_MANY_TOOL_CALLS",
"MISSING_THOUGHT_SIGNATURE",
"MALFORMED_RESPONSE",
"ESCALATION",
"PUP_LIMITED_DISABLED"
],
"type": "string"
},
{
"const": "CONTINUATION",
"description": "This hop ended, but generation requires another request with its token.",
"type": "string"
}
]
}Output_FinishReason2
Complete JSON Schema
{
"enum": [
"stop",
"length",
"tool_calls",
"content_filter",
"function_call"
],
"type": "string"
}Output_FontStatus
Complete JSON Schema
{
"properties": {
"completed": {
"format": "uint",
"minimum": 0,
"type": "integer"
},
"downloading": {
"type": "boolean"
},
"installed": {
"type": "boolean"
},
"total": {
"format": "uint",
"minimum": 0,
"type": "integer"
}
},
"required": [
"installed",
"downloading",
"completed",
"total"
],
"type": "object"
}Output_FunctionCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_FunctionCallType, Output_ItemStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"async": {
"type": [
"boolean",
"null"
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"namespace": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_FunctionCallType"
}
},
"required": [
"type",
"arguments",
"call_id",
"name"
],
"type": "object"
}Output_FunctionCall2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"args": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Output_FunctionCall3
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"arguments": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"arguments",
"name"
],
"type": "object"
}Output_FunctionCallArgumentsDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"delta"
],
"type": "object"
}Output_FunctionCallArgumentsDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"item_id": {
"type": "string"
},
"name": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"name",
"arguments"
],
"type": "object"
}Output_FunctionCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_FunctionCallOutputType, Output_FunctionOutput, Output_ItemStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": [
"string",
"null"
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"namespace": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Output_FunctionOutput"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_FunctionCallOutputType"
}
},
"required": [
"type",
"output"
],
"type": "object"
}Output_FunctionCallOutputType
Complete JSON Schema
{
"enum": [
"function_call_output"
],
"type": "string"
}Output_FunctionCallType
Complete JSON Schema
{
"enum": [
"function_call"
],
"type": "string"
}Output_FunctionOutput
Complete JSON Schema
Referenced structures: Output_FunctionOutputContent
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Output_FunctionOutputContent"
},
"type": "array"
}
]
}Output_FunctionOutputContent
Complete JSON Schema
Referenced structures: Output_FunctionOutputFile, Output_FunctionOutputImage, Output_FunctionOutputText
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_FunctionOutputText"
},
{
"$ref": "#/components/schemas/Output_FunctionOutputImage"
},
{
"$ref": "#/components/schemas/Output_FunctionOutputFile"
}
]
}Output_FunctionOutputFile
Complete JSON Schema
Referenced structures: Output_FileDetail, Output_PromptCacheBreakpoint, Output_ResponseInputFileType
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileDetail"
},
{
"type": "null"
}
]
},
"file_data": {
"type": [
"string",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"file_url": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputFileType"
}
},
"required": [
"type"
],
"type": "object"
}Output_FunctionOutputImage
Complete JSON Schema
Referenced structures: Output_ImageDetail, Output_PromptCacheBreakpoint, Output_ResponseInputImageType
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageDetail"
},
{
"type": "null"
}
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputImageType"
}
},
"required": [
"type"
],
"type": "object"
}Output_FunctionOutputText
Complete JSON Schema
Referenced structures: Output_PromptCacheBreakpoint, Output_ResponseInputTextType
{
"additionalProperties": true,
"properties": {
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_FunctionResponse
Complete JSON Schema
Referenced structures: Output_FunctionResponsePart, Output_Scheduling
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"parts": {
"items": {
"$ref": "#/components/schemas/Output_FunctionResponsePart"
},
"type": [
"array",
"null"
]
},
"response": {
"additionalProperties": true,
"type": "object"
},
"scheduling": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Scheduling"
},
{
"type": "null"
}
]
},
"willContinue": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"response"
],
"type": "object"
}Output_FunctionResponsePart
Complete JSON Schema
Referenced structures: Output_Blob
{
"additionalProperties": true,
"properties": {
"inlineData": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Blob"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_FunctionTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"output_schema": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"parameters": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"strict": {
"default": null,
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"parameters",
"strict"
],
"type": "object"
}Output_GenerateContentError
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"details": {
"items": true,
"type": [
"array",
"null"
]
},
"message": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
}
},
"required": [
"code",
"message"
],
"type": "object"
}Output_GenerateContentResponseBody
Complete JSON Schema
Referenced structures: Output_GenerateTruncation, Output_Input, Output_PromptCacheDiagnostics, Output_PromptCacheRetention, Output_ReasoningConfig, Output_ResponseAccessPrograms, Output_ResponseConversationParam, Output_ResponseError, Output_ResponseIncompleteDetails, Output_ResponseModerationReport, Output_ResponseObject, Output_ResponseOutputItem, Output_ResponsePrompt, Output_ResponsePromptCacheOptions, Output_ResponseStatus, Output_ResponseUsage, Output_ServiceTier, Output_TextConfig, Output_Tool, Output_ToolChoice
{
"additionalProperties": true,
"properties": {
"access_programs": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseAccessPrograms"
},
{
"type": "null"
}
],
"description": "Newer API responses report this even when null; older responses omit it."
},
"background": {
"type": [
"boolean",
"null"
]
},
"completed_at": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"conversation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseConversationParam"
},
{
"type": "null"
}
]
},
"created_at": {
"format": "int64",
"type": "integer"
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseError"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"incomplete_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseIncompleteDetails"
},
{
"type": "null"
}
]
},
"instructions": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Input"
},
{
"type": "null"
}
]
},
"max_output_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_tool_calls": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"model": {
"type": "string"
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseModerationReport"
},
{
"type": "null"
}
]
},
"object": {
"$ref": "#/components/schemas/Output_ResponseObject"
},
"output": {
"items": {
"$ref": "#/components/schemas/Output_ResponseOutputItem"
},
"type": "array"
},
"output_text": {
"type": [
"string",
"null"
]
},
"parallel_tool_calls": {
"type": "boolean"
},
"previous_response_id": {
"type": [
"string",
"null"
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponsePrompt"
},
{
"type": "null"
}
]
},
"prompt_cache_diagnostics": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheDiagnostics"
},
{
"type": "null"
}
]
},
"prompt_cache_key": {
"type": [
"string",
"null"
]
},
"prompt_cache_options": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponsePromptCacheOptions"
},
{
"type": "null"
}
]
},
"prompt_cache_retention": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheRetention"
},
{
"type": "null"
}
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningConfig"
},
{
"type": "null"
}
]
},
"safety_identifier": {
"type": [
"string",
"null"
]
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ServiceTier"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseStatus"
},
{
"type": "null"
}
]
},
"temperature": {
"type": [
"number",
"null"
]
},
"text": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TextConfig"
},
{
"type": "null"
}
]
},
"tool_choice": {
"$ref": "#/components/schemas/Output_ToolChoice"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_Tool"
},
"type": "array"
},
"top_logprobs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"top_p": {
"type": [
"number",
"null"
]
},
"truncation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GenerateTruncation"
},
{
"type": "null"
}
]
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseUsage"
},
{
"type": "null"
}
]
},
"user": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"created_at",
"error",
"incomplete_details",
"instructions",
"metadata",
"model",
"object",
"output",
"parallel_tool_calls",
"temperature",
"tool_choice",
"tools",
"top_p"
],
"type": "object"
}Output_GenerateContentResponseBody2
Complete JSON Schema
Referenced structures: Output_ContextManagementResponse, Output_DiagnosticsResponse, Output_GenerateContentResponseBodyType, Output_InputTransformation, Output_RefusalStopDetails, Output_ResponseContainer, Output_ResponseContentBlock, Output_ResponseRole, Output_StopReason, Output_Usage
{
"additionalProperties": true,
"properties": {
"container": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseContainer"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Output_ResponseContentBlock"
},
"type": "array"
},
"context_management": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ContextManagementResponse"
},
{
"type": "null"
}
]
},
"diagnostics": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DiagnosticsResponse"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input_transformations": {
"items": {
"$ref": "#/components/schemas/Output_InputTransformation"
},
"type": [
"array",
"null"
]
},
"model": {
"type": "string"
},
"role": {
"$ref": "#/components/schemas/Output_ResponseRole"
},
"stop_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RefusalStopDetails"
},
{
"type": "null"
}
]
},
"stop_reason": {
"$ref": "#/components/schemas/Output_StopReason"
},
"stop_sequence": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBodyType"
},
"usage": {
"$ref": "#/components/schemas/Output_Usage"
}
},
"required": [
"type",
"id",
"content",
"model",
"role",
"stop_reason",
"usage"
],
"type": "object"
}Output_GenerateContentResponseBody3
Complete JSON Schema
Referenced structures: Output_Candidate, Output_GenerateContentError, Output_ModelStatus, Output_PromptFeedback, Output_UsageMetadata
{
"additionalProperties": true,
"properties": {
"candidates": {
"items": {
"$ref": "#/components/schemas/Output_Candidate"
},
"type": [
"array",
"null"
]
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GenerateContentError"
},
{
"type": "null"
}
],
"description": "A Google API error can arrive as a record inside a successful HTTP stream."
},
"modelStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelStatus"
},
{
"type": "null"
}
]
},
"modelVersion": {
"type": [
"string",
"null"
]
},
"promptFeedback": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptFeedback"
},
{
"type": "null"
}
]
},
"responseId": {
"type": [
"string",
"null"
]
},
"usageMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UsageMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_GenerateContentResponseBody4
Complete JSON Schema
Referenced structures: Output_Choice, Output_CompletionObject, Output_ModerationResponse, Output_ResponseServiceTier2, Output_Usage2
{
"additionalProperties": true,
"properties": {
"choices": {
"items": {
"$ref": "#/components/schemas/Output_Choice"
},
"type": "array"
},
"created": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"model": {
"type": "string"
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModerationResponse"
},
{
"type": "null"
}
]
},
"object": {
"$ref": "#/components/schemas/Output_CompletionObject"
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseServiceTier2"
},
{
"type": "null"
}
]
},
"system_fingerprint": {
"type": [
"string",
"null"
]
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Usage2"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"choices",
"created",
"model",
"object"
],
"type": "object"
}Output_GenerateContentResponseBodyType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Output_GenerateTruncation
Complete JSON Schema
{
"enum": [
"auto",
"disabled"
],
"type": "string"
}Output_GeneratedImage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"b64_json": {
"type": [
"string",
"null"
]
},
"revised_prompt": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_GoAway
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"timeLeft": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_GrammarFormat
Complete JSON Schema
Referenced structures: Output_GrammarFormatType, Output_GrammarSyntax
{
"additionalProperties": true,
"properties": {
"definition": {
"type": "string"
},
"syntax": {
"$ref": "#/components/schemas/Output_GrammarSyntax"
},
"type": {
"$ref": "#/components/schemas/Output_GrammarFormatType"
}
},
"required": [
"definition",
"syntax",
"type"
],
"type": "object"
}Output_GrammarFormatType
Complete JSON Schema
{
"enum": [
"grammar"
],
"type": "string"
}Output_GrammarSyntax
Complete JSON Schema
{
"enum": [
"lark",
"regex"
],
"type": "string"
}Output_GroundingAttribution
Complete JSON Schema
Referenced structures: Output_AttributionSourceId, Output_Content
{
"additionalProperties": true,
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Content"
},
{
"type": "null"
}
]
},
"sourceId": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AttributionSourceId"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_GroundingChunk
Complete JSON Schema
Referenced structures: Output_Image, Output_Maps, Output_RetrievedContext, Output_Web
{
"additionalProperties": true,
"properties": {
"image": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Image"
},
{
"type": "null"
}
]
},
"maps": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Maps"
},
{
"type": "null"
}
]
},
"retrievedContext": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RetrievedContext"
},
{
"type": "null"
}
]
},
"web": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Web"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_GroundingMetadata
Complete JSON Schema
Referenced structures: Output_GroundingChunk, Output_GroundingSupport, Output_RetrievalMetadata, Output_SearchEntryPoint
{
"additionalProperties": true,
"properties": {
"googleMapsWidgetContextToken": {
"type": [
"string",
"null"
]
},
"groundingChunks": {
"items": {
"$ref": "#/components/schemas/Output_GroundingChunk"
},
"type": [
"array",
"null"
]
},
"groundingSupports": {
"items": {
"$ref": "#/components/schemas/Output_GroundingSupport"
},
"type": [
"array",
"null"
]
},
"imageSearchQueries": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"retrievalMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RetrievalMetadata"
},
{
"type": "null"
}
]
},
"searchEntryPoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SearchEntryPoint"
},
{
"type": "null"
}
]
},
"webSearchQueries": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_GroundingPassageId
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"partIndex": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"passageId": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_GroundingSupport
Complete JSON Schema
Referenced structures: Output_Segment
{
"additionalProperties": true,
"properties": {
"confidenceScores": {
"items": {
"format": "double",
"type": "number"
},
"type": [
"array",
"null"
]
},
"groundingChunkIndices": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"renderedParts": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"segment": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Segment"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_GuardianModelPolicy
Complete JSON Schema
Referenced structures: Output_GuardianReviewMode, Output_GuardianUnscoredAction
{
"additionalProperties": true,
"properties": {
"computer_use": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianReviewMode"
},
{
"type": "null"
}
]
},
"file_changes": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianReviewMode"
},
{
"type": "null"
}
]
},
"initial_cua_call": {
"type": [
"boolean",
"null"
]
},
"mcp": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianReviewMode"
},
{
"type": "null"
}
]
},
"network": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianReviewMode"
},
{
"type": "null"
}
]
},
"other_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianReviewMode"
},
{
"type": "null"
}
]
},
"permissions": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianReviewMode"
},
{
"type": "null"
}
]
},
"sandboxed_exec_commands": {
"type": [
"boolean",
"null"
]
},
"shell": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianReviewMode"
},
{
"type": "null"
}
]
},
"unscored_action": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianUnscoredAction"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_GuardianReviewMode
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"disabled",
"synchronous",
"adaptive"
],
"type": "string"
},
{
"type": "string"
}
]
}Output_GuardianUnscoredAction
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"ignore",
"age_score",
"invalidate_score"
],
"type": "string"
},
{
"type": "string"
}
]
}Output_GuardianV2ModelConfig
Complete JSON Schema
Referenced structures: Output_AsyncClassifierMode, Output_GuardianV2TranscriptModelConfig, Output_ModelReasoningEffort
{
"additionalProperties": true,
"properties": {
"async_classifier_conversation_token_limit": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"async_classifier_mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AsyncClassifierMode"
},
{
"type": "null"
}
]
},
"classifier_instructions": {
"type": [
"string",
"null"
]
},
"max_action_tokens": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_classifier_instruction_tokens": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_parent_compaction_tokens": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_tool_call_lag": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"reasoning_effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelReasoningEffort"
},
{
"type": "null"
}
]
},
"reuse_parent_compaction": {
"type": [
"boolean",
"null"
]
},
"review_threshold_basis_points": {
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"transcript": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianV2TranscriptModelConfig"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_GuardianV2TranscriptModelConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"include_images": {
"type": [
"boolean",
"null"
]
},
"max_message_entry_tokens": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_message_transcript_tokens": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_recent_non_user_entries": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_tool_entry_tokens": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_tool_transcript_tokens": {
"format": "uint",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"sources": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_HarmCategory
Complete JSON Schema
{
"enum": [
"HARM_CATEGORY_UNSPECIFIED",
"HARM_CATEGORY_HARASSMENT",
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_SEXUALLY_EXPLICIT",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_CIVIC_INTEGRITY",
"HARM_CATEGORY_DEROGATORY",
"HARM_CATEGORY_TOXICITY",
"HARM_CATEGORY_VIOLENCE",
"HARM_CATEGORY_SEXUAL",
"HARM_CATEGORY_MEDICAL",
"HARM_CATEGORY_DANGEROUS",
"HARM_CATEGORY_JAILBREAK"
],
"type": "string"
}Output_HarmProbability
Complete JSON Schema
{
"enum": [
"HARM_PROBABILITY_UNSPECIFIED",
"NEGLIGIBLE",
"LOW",
"MEDIUM",
"HIGH"
],
"type": "string"
}Output_HistoryDeleted
Complete JSON Schema
{
"description": "How many history rows a deletion removed.",
"properties": {
"deleted": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"deleted"
],
"type": "object"
}Output_HybridSearch
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"embedding_weight": {
"type": "number"
},
"text_weight": {
"type": "number"
}
},
"required": [
"embedding_weight",
"text_weight"
],
"type": "object"
}Output_Image
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"domain": {
"type": [
"string",
"null"
]
},
"imageUri": {
"type": [
"string",
"null"
]
},
"sourceUri": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ImageAction
Complete JSON Schema
{
"enum": [
"generate",
"edit",
"auto"
],
"type": "string"
}Output_ImageBackground
Complete JSON Schema
{
"enum": [
"transparent",
"opaque",
"auto"
],
"type": "string"
}Output_ImageBackground2
Complete JSON Schema
{
"enum": [
"transparent",
"opaque",
"auto"
],
"type": "string"
}Output_ImageCall
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index"
],
"type": "object"
}Output_ImageCompletedEvent
Complete JSON Schema
Referenced structures: Output_ImageBackground2, Output_ImageOutputFormat2, Output_ImageUsage, Output_StreamImageQuality
{
"additionalProperties": true,
"properties": {
"b64_json": {
"type": "string"
},
"background": {
"$ref": "#/components/schemas/Output_ImageBackground2"
},
"created_at": {
"format": "int64",
"type": "integer"
},
"output_format": {
"$ref": "#/components/schemas/Output_ImageOutputFormat2"
},
"quality": {
"$ref": "#/components/schemas/Output_StreamImageQuality"
},
"size": {
"type": "string"
},
"usage": {
"$ref": "#/components/schemas/Output_ImageUsage"
}
},
"required": [
"b64_json",
"background",
"created_at",
"output_format",
"quality",
"size",
"usage"
],
"type": "object"
}Output_ImageDetail
Complete JSON Schema
{
"enum": [
"low",
"high",
"auto",
"original"
],
"type": "string"
}Output_ImageDetail2
Complete JSON Schema
{
"description": "Source: `openai/types/responses/image_detail.py`, `ImageDetail`.",
"enum": [
"low",
"high",
"auto",
"original"
],
"type": "string"
}Output_ImageEditStreamEvent
Complete JSON Schema
Referenced structures: Output_ImageCompletedEvent, Output_ImagePartialEvent
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_ImagePartialEvent",
"properties": {
"type": {
"const": "image_edit.partial_image",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ImageCompletedEvent",
"properties": {
"type": {
"const": "image_edit.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ImageGenerationCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_ImageAction, Output_ImageBackground, Output_ImageGenerationCallError, Output_ImageGenerationCallType, Output_ImageGenerationStatus, Output_ImageOutputFormat, Output_ImageQuality
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageAction"
},
{
"type": "null"
}
]
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageBackground"
},
{
"type": "null"
}
]
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageGenerationCallError"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageOutputFormat"
},
{
"type": "null"
}
]
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageQuality"
},
{
"type": "null"
}
]
},
"result": {
"type": [
"string",
"null"
]
},
"revised_prompt": {
"type": [
"string",
"null"
]
},
"size": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Output_ImageGenerationStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ImageGenerationCallType"
}
},
"required": [
"type",
"id",
"result",
"status"
],
"type": "object"
}Output_ImageGenerationCallError
Complete JSON Schema
Referenced structures: Output_ImageModerationDetails
{
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"message": {
"type": "string"
},
"moderation_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageModerationDetails"
},
{
"type": "null"
}
]
},
"param": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"code",
"message",
"param",
"type"
],
"type": "object"
}Output_ImageGenerationCallType
Complete JSON Schema
{
"enum": [
"image_generation_call"
],
"type": "string"
}Output_ImageGenerationStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"generating",
"failed"
],
"type": "string"
}Output_ImageGenerationStreamEvent
Complete JSON Schema
Referenced structures: Output_ImageCompletedEvent, Output_ImagePartialEvent
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_ImagePartialEvent",
"properties": {
"type": {
"const": "image_generation.partial_image",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ImageCompletedEvent",
"properties": {
"type": {
"const": "image_generation.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ImageGenerationTool
Complete JSON Schema
Referenced structures: Output_ImageAction, Output_ImageBackground, Output_ImageOutputFormat, Output_ImageQuality, Output_InputFidelity, Output_InputImageMask, Output_Moderation
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageAction"
},
{
"type": "null"
}
]
},
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageBackground"
},
{
"type": "null"
}
]
},
"input_fidelity": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_InputFidelity"
},
{
"type": "null"
}
]
},
"input_image_mask": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_InputImageMask"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"moderation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Moderation"
},
{
"type": "null"
}
]
},
"output_compression": {
"type": [
"number",
"null"
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageOutputFormat"
},
{
"type": "null"
}
]
},
"partial_images": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageQuality"
},
{
"type": "null"
}
]
},
"size": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ImageModerationDetails
Complete JSON Schema
Referenced structures: Output_ImageModerationStage
{
"additionalProperties": true,
"properties": {
"categories": {
"items": {
"type": "string"
},
"type": "array"
},
"moderation_stage": {
"$ref": "#/components/schemas/Output_ImageModerationStage"
}
},
"required": [
"categories",
"moderation_stage"
],
"type": "object"
}Output_ImageModerationStage
Complete JSON Schema
{
"enum": [
"input",
"output",
"unknown"
],
"type": "string"
}Output_ImageOutputFormat
Complete JSON Schema
{
"enum": [
"png",
"webp",
"jpeg"
],
"type": "string"
}Output_ImageOutputFormat2
Complete JSON Schema
{
"enum": [
"png",
"jpeg",
"webp"
],
"type": "string"
}Output_ImagePartial
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"partial_image_b64": {
"type": "string"
},
"partial_image_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"partial_image_index",
"partial_image_b64"
],
"type": "object"
}Output_ImagePartialEvent
Complete JSON Schema
Referenced structures: Output_ImageBackground2, Output_ImageOutputFormat2, Output_StreamImageQuality
{
"additionalProperties": true,
"properties": {
"b64_json": {
"type": "string"
},
"background": {
"$ref": "#/components/schemas/Output_ImageBackground2"
},
"created_at": {
"format": "int64",
"type": "integer"
},
"output_format": {
"$ref": "#/components/schemas/Output_ImageOutputFormat2"
},
"partial_image_index": {
"format": "int64",
"type": "integer"
},
"quality": {
"$ref": "#/components/schemas/Output_StreamImageQuality"
},
"size": {
"type": "string"
}
},
"required": [
"b64_json",
"background",
"created_at",
"output_format",
"partial_image_index",
"quality",
"size"
],
"type": "object"
}Output_ImageQuality
Complete JSON Schema
{
"enum": [
"xhigh",
"max",
"low",
"medium",
"high",
"auto"
],
"type": "string"
}Output_ImageTokenDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"image_tokens": {
"format": "int64",
"type": "integer"
},
"text_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"image_tokens",
"text_tokens"
],
"type": "object"
}Output_ImageUsage
Complete JSON Schema
Referenced structures: Output_ImageTokenDetails
{
"additionalProperties": true,
"properties": {
"input_tokens": {
"format": "int64",
"type": "integer"
},
"input_tokens_details": {
"$ref": "#/components/schemas/Output_ImageTokenDetails"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageTokenDetails"
},
{
"type": "null"
}
]
},
"total_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"input_tokens",
"input_tokens_details",
"output_tokens",
"total_tokens"
],
"type": "object"
}Output_ImagesResponse
Complete JSON Schema
Referenced structures: Output_GeneratedImage, Output_ImageOutputFormat2, Output_ImageUsage, Output_OutputImageBackground, Output_OutputImageQuality, Output_OutputImageSize
{
"additionalProperties": true,
"properties": {
"background": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_OutputImageBackground"
},
{
"type": "null"
}
]
},
"created": {
"format": "int64",
"type": "integer"
},
"data": {
"items": {
"$ref": "#/components/schemas/Output_GeneratedImage"
},
"type": [
"array",
"null"
]
},
"output_format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageOutputFormat2"
},
{
"type": "null"
}
]
},
"quality": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_OutputImageQuality"
},
{
"type": "null"
}
]
},
"size": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_OutputImageSize"
},
{
"type": "null"
}
]
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ImageUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"created"
],
"type": "object"
}Output_ImportReportDto
Complete JSON Schema
{
"description": "What one import did. The counters are rows, across every kind; the warnings\nare the things that were silently changed rather than refused, which is the\nonly place a caller learns that a credential arrived unusable.",
"properties": {
"created": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"credentialsResealed": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"credentialsSkipped": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"skipped": {
"description": "Rows the document named that were not written, which today is exactly\nthe credentials whose secret could not be opened. What `Replace`\ndeleted is reported as a warning instead: a removal is not a skip.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"updated": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"warnings": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"created",
"updated",
"skipped",
"credentialsResealed",
"credentialsSkipped",
"warnings"
],
"type": "object"
}Output_IndirectDescriptionPrefixes
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"mcp_servers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"namespaces": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
}
},
"type": "object"
}Output_InjectCreated
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"response_id": {
"type": "string"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response_id"
],
"type": "object"
}Output_InjectError
Complete JSON Schema
Referenced structures: Output_InjectErrorCode
{
"additionalProperties": true,
"properties": {
"code": {
"$ref": "#/components/schemas/Output_InjectErrorCode"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
}Output_InjectErrorCode
Complete JSON Schema
{
"enum": [
"response_already_completed",
"response_not_found"
],
"type": "string"
}Output_InjectFailed
Complete JSON Schema
Referenced structures: Output_InjectError, Output_InputItem
{
"additionalProperties": true,
"properties": {
"error": {
"$ref": "#/components/schemas/Output_InjectError"
},
"input": {
"items": {
"$ref": "#/components/schemas/Output_InputItem"
},
"type": "array"
},
"response_id": {
"type": "string"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response_id",
"input",
"error"
],
"type": "object"
}Output_InjectionEvent
Complete JSON Schema
Referenced structures: Output_InjectCreated, Output_InjectFailed
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_InjectCreated",
"properties": {
"type": {
"const": "response.inject.created",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_InjectFailed",
"properties": {
"type": {
"const": "response.inject.failed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_InlineSkill
Complete JSON Schema
Referenced structures: Output_InlineSkillSource, Output_InlineSkillType
{
"additionalProperties": true,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"source": {
"$ref": "#/components/schemas/Output_InlineSkillSource"
},
"type": {
"$ref": "#/components/schemas/Output_InlineSkillType"
}
},
"required": [
"description",
"name",
"source",
"type"
],
"type": "object"
}Output_InlineSkillSource
Complete JSON Schema
Referenced structures: Output_Base64SourceType, Output_ZipMediaType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"media_type": {
"$ref": "#/components/schemas/Output_ZipMediaType"
},
"type": {
"$ref": "#/components/schemas/Output_Base64SourceType"
}
},
"required": [
"data",
"media_type",
"type"
],
"type": "object"
}Output_InlineSkillType
Complete JSON Schema
{
"enum": [
"inline"
],
"type": "string"
}Output_Input
Complete JSON Schema
Referenced structures: Output_InputItem
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Output_InputItem"
},
"type": "array"
}
]
}Output_InputAudioBufferClearedEvent
Complete JSON Schema
Referenced structures: Output_InputAudioBufferClearedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_cleared_event.py`, `InputAudioBufferClearedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_InputAudioBufferClearedEventType"
}
},
"required": [
"event_id",
"type"
],
"type": "object"
}Output_InputAudioBufferClearedEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.cleared"
],
"type": "string"
}Output_InputAudioBufferCommittedEvent
Complete JSON Schema
Referenced structures: Output_InputAudioBufferCommittedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_committed_event.py`, `InputAudioBufferCommittedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"previous_item_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_InputAudioBufferCommittedEventType"
}
},
"required": [
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_InputAudioBufferCommittedEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.committed"
],
"type": "string"
}Output_InputAudioBufferDtmfEventReceivedEvent
Complete JSON Schema
Referenced structures: Output_InputAudioBufferDtmfEventReceivedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_dtmf_event_received_event.py`, `InputAudioBufferDtmfEventReceivedEvent`.",
"properties": {
"event": {
"type": "string"
},
"received_at": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_InputAudioBufferDtmfEventReceivedEventType"
}
},
"required": [
"event",
"received_at",
"type"
],
"type": "object"
}Output_InputAudioBufferDtmfEventReceivedEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.dtmf_event_received"
],
"type": "string"
}Output_InputAudioBufferSpeechStartedEvent
Complete JSON Schema
Referenced structures: Output_InputAudioBufferSpeechStartedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_speech_started_event.py`, `InputAudioBufferSpeechStartedEvent`.",
"properties": {
"audio_start_ms": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_InputAudioBufferSpeechStartedEventType"
}
},
"required": [
"audio_start_ms",
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_InputAudioBufferSpeechStartedEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.speech_started"
],
"type": "string"
}Output_InputAudioBufferSpeechStoppedEvent
Complete JSON Schema
Referenced structures: Output_InputAudioBufferSpeechStoppedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_speech_stopped_event.py`, `InputAudioBufferSpeechStoppedEvent`.",
"properties": {
"audio_end_ms": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_InputAudioBufferSpeechStoppedEventType"
}
},
"required": [
"audio_end_ms",
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_InputAudioBufferSpeechStoppedEventType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.speech_stopped"
],
"type": "string"
}Output_InputAudioBufferTimeoutTriggered
Complete JSON Schema
Referenced structures: Output_InputAudioBufferTimeoutTriggeredType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/input_audio_buffer_timeout_triggered.py`, `InputAudioBufferTimeoutTriggered`.",
"properties": {
"audio_end_ms": {
"format": "int64",
"type": "integer"
},
"audio_start_ms": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_InputAudioBufferTimeoutTriggeredType"
}
},
"required": [
"audio_end_ms",
"audio_start_ms",
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_InputAudioBufferTimeoutTriggeredType
Complete JSON Schema
{
"enum": [
"input_audio_buffer.timeout_triggered"
],
"type": "string"
}Output_InputContent
Complete JSON Schema
Referenced structures: Output_ResponseInputFile, Output_ResponseInputImage, Output_ResponseInputText
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseInputText"
},
{
"$ref": "#/components/schemas/Output_ResponseInputImage"
},
{
"$ref": "#/components/schemas/Output_ResponseInputFile"
}
]
}Output_InputFidelity
Complete JSON Schema
{
"enum": [
"low",
"high"
],
"type": "string"
}Output_InputImageMask
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_InputItem
Complete JSON Schema
Referenced structures: Output_AdditionalTools, Output_AgentMessage, Output_ApplyPatchCall, Output_ApplyPatchCallOutput, Output_CodeInterpreterCall, Output_Compaction, Output_CompactionTrigger, Output_ComputerCall, Output_ComputerCallOutput, Output_ConfigurationUpdate, Output_CustomToolCall, Output_CustomToolCallOutput, Output_EasyInputMessage, Output_FileSearchCall, Output_FunctionCall, Output_FunctionCallOutput, Output_ImageGenerationCall, Output_InputMessage, Output_ItemReference, Output_LocalShellCall, Output_LocalShellCallOutput, Output_McpApprovalRequest, Output_McpApprovalResponse, Output_McpCall, Output_McpListTools, Output_MultiAgentCall, Output_MultiAgentCallOutput, Output_Program, Output_ProgramOutput, Output_ReasoningItem, Output_ResponseOutputMessage, Output_ShellCall, Output_ShellCallOutput, Output_ToolSearchCall, Output_ToolSearchOutput, Output_WebSearchCall
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_MultiAgentCall"
},
{
"$ref": "#/components/schemas/Output_MultiAgentCallOutput"
},
{
"$ref": "#/components/schemas/Output_AgentMessage"
},
{
"$ref": "#/components/schemas/Output_ConfigurationUpdate"
},
{
"$ref": "#/components/schemas/Output_ResponseOutputMessage"
},
{
"$ref": "#/components/schemas/Output_InputMessage"
},
{
"$ref": "#/components/schemas/Output_EasyInputMessage"
},
{
"$ref": "#/components/schemas/Output_FunctionCall"
},
{
"$ref": "#/components/schemas/Output_FunctionCallOutput"
},
{
"$ref": "#/components/schemas/Output_ReasoningItem"
},
{
"$ref": "#/components/schemas/Output_ItemReference"
},
{
"$ref": "#/components/schemas/Output_Compaction"
},
{
"$ref": "#/components/schemas/Output_ComputerCall"
},
{
"$ref": "#/components/schemas/Output_ComputerCallOutput"
},
{
"$ref": "#/components/schemas/Output_WebSearchCall"
},
{
"$ref": "#/components/schemas/Output_FileSearchCall"
},
{
"$ref": "#/components/schemas/Output_ImageGenerationCall"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterCall"
},
{
"$ref": "#/components/schemas/Output_CustomToolCall"
},
{
"$ref": "#/components/schemas/Output_CustomToolCallOutput"
},
{
"$ref": "#/components/schemas/Output_ToolSearchCall"
},
{
"$ref": "#/components/schemas/Output_ToolSearchOutput"
},
{
"$ref": "#/components/schemas/Output_AdditionalTools"
},
{
"$ref": "#/components/schemas/Output_LocalShellCall"
},
{
"$ref": "#/components/schemas/Output_LocalShellCallOutput"
},
{
"$ref": "#/components/schemas/Output_ShellCall"
},
{
"$ref": "#/components/schemas/Output_ShellCallOutput"
},
{
"$ref": "#/components/schemas/Output_ApplyPatchCall"
},
{
"$ref": "#/components/schemas/Output_ApplyPatchCallOutput"
},
{
"$ref": "#/components/schemas/Output_McpListTools"
},
{
"$ref": "#/components/schemas/Output_McpApprovalRequest"
},
{
"$ref": "#/components/schemas/Output_McpApprovalResponse"
},
{
"$ref": "#/components/schemas/Output_McpCall"
},
{
"$ref": "#/components/schemas/Output_CompactionTrigger"
},
{
"$ref": "#/components/schemas/Output_Program"
},
{
"$ref": "#/components/schemas/Output_ProgramOutput"
}
]
}Output_InputJsonDelta
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"partial_json": {
"type": "string"
}
},
"required": [
"partial_json"
],
"type": "object"
}Output_InputMessage
Complete JSON Schema
Referenced structures: Output_Agent, Output_InputContent, Output_InputMessageRole, Output_MessageType, Output_OutputMessageStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Output_InputContent"
},
"type": "array"
},
"role": {
"$ref": "#/components/schemas/Output_InputMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_OutputMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MessageType"
},
{
"type": "null"
}
]
}
},
"required": [
"content",
"role"
],
"type": "object"
}Output_InputMessageRole
Complete JSON Schema
{
"enum": [
"user",
"system",
"developer"
],
"type": "string"
}Output_InputTransformation
Complete JSON Schema
Referenced structures: Output_InputTransformationType, Output_ThinkingBindingMismatchReason
{
"additionalProperties": true,
"properties": {
"path": {
"type": "string"
},
"reason": {
"$ref": "#/components/schemas/Output_ThinkingBindingMismatchReason"
},
"type": {
"$ref": "#/components/schemas/Output_InputTransformationType"
}
},
"required": [
"type",
"path",
"reason"
],
"type": "object"
}Output_InputTransformationType
Complete JSON Schema
{
"enum": [
"thinking_dropped",
"thinking_mismatch_allowed",
"unknown"
],
"type": "string"
}Output_InstanceSettingsDto
Complete JSON Schema
{
"additionalProperties": false,
"description": "Identity, network, execution limits and maintenance. `config_revision` is\nread-only: it is the write path's own counter.",
"properties": {
"allowedHeaders": {
"default": []
},
"alwaysSecureCookie": {
"default": false,
"description": "Absent in an export from a build without it, which reads as off.",
"type": "boolean"
},
"capturePayloadMaxMb": {
"default": 2048,
"format": "int64",
"type": [
"integer",
"null"
]
},
"capturePayloadRetentionDays": {
"default": 7,
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"configRevision": {
"format": "int64",
"type": "integer"
},
"connectionProfileId": {
"type": [
"string",
"null"
]
},
"corsOrigins": true,
"defaultVocabularyFileId": {
"type": [
"string",
"null"
]
},
"enableAutoUpdateCheck": {
"type": "boolean"
},
"enableSettlement": {
"type": "boolean"
},
"enableTokenizerDownload": {
"type": "boolean"
},
"enableTokenizerVocabs": {
"type": "boolean"
},
"enableUsage": {
"type": "boolean"
},
"hasTokenizerAuthToken": {
"description": "The vocabulary source token is sealed like a credential secret; only\nits presence is reported.",
"type": "boolean"
},
"instanceName": {
"type": "string"
},
"maxAttempts": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"maxDatabaseSizeMb": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxMultipartParts": {
"default": 64,
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"maxRequestBodyBytes": {
"default": 52428800,
"format": "int64",
"type": "integer"
},
"maxResponseBodyBytes": {
"default": 268435456,
"format": "int64",
"type": "integer"
},
"maxStreamEventBytes": {
"default": 33554432,
"format": "int64",
"type": "integer"
},
"maxUploadBodyBytes": {
"default": 536870912,
"format": "int64",
"type": "integer"
},
"maxWsFrameBytes": {
"default": 33554432,
"format": "int64",
"type": "integer"
},
"oauthClientAllowlist": true,
"portalRecentRequestsEnabled": {
"type": "boolean"
},
"proxy": {
"default": null
},
"quotaObservationRetentionDays": {
"default": 90,
"description": "Days of upstream quota observations to keep; None keeps them all.\nCycles are never pruned. Absent in an older export, which reads as\nthe 90-day default.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"requestTimeoutMs": {
"default": 1200000,
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"retentionDays": {
"description": "Days of completed request captures to keep; None keeps them all.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"streamIdleTimeoutMs": {
"default": 300000,
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"trustedProxies": true,
"updateChannel": {
"type": [
"string",
"null"
]
},
"updateSource": {
"type": [
"string",
"null"
]
},
"updateVerifySignature": {
"type": [
"boolean",
"null"
]
},
"usageRetentionDays": {
"default": null,
"description": "Days of usage records to keep; None keeps them all. Usage statistics\nand totals are computed from these. Absent in an older export, which\nreads as keeping everything.",
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"instanceName",
"allowedHeaders",
"oauthClientAllowlist",
"connectionProfileId",
"proxy",
"corsOrigins",
"trustedProxies",
"alwaysSecureCookie",
"maxAttempts",
"enableSettlement",
"enableUsage",
"configRevision",
"requestTimeoutMs",
"streamIdleTimeoutMs",
"maxRequestBodyBytes",
"maxUploadBodyBytes",
"maxResponseBodyBytes",
"maxStreamEventBytes",
"maxWsFrameBytes",
"maxMultipartParts",
"enableTokenizerVocabs",
"enableTokenizerDownload",
"defaultVocabularyFileId",
"hasTokenizerAuthToken",
"retentionDays",
"usageRetentionDays",
"capturePayloadRetentionDays",
"capturePayloadMaxMb",
"quotaObservationRetentionDays",
"maxDatabaseSizeMb",
"updateChannel",
"updateSource",
"updateVerifySignature",
"enableAutoUpdateCheck",
"portalRecentRequestsEnabled"
],
"type": "object"
}Output_InteractionStatus
Complete JSON Schema
{
"enum": [
"INTERACTION_STATUS_UNSPECIFIED",
"IN_PROGRESS",
"REQUIRES_ACTION",
"IDLE"
],
"type": "string"
}Output_InterruptEvent
Complete JSON Schema
{
"oneOf": [
{
"properties": {
"response_id": {
"type": "string"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"type": {
"const": "response.interrupt.accepted",
"type": "string"
}
},
"required": [
"type",
"response_id",
"sequence_number"
],
"type": "object"
},
{
"properties": {
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"type": {
"const": "response.output_item.interrupted",
"type": "string"
}
},
"required": [
"type",
"response_id",
"item_id",
"output_index",
"sequence_number"
],
"type": "object"
}
]
}Output_ItemReference
Complete JSON Schema
Referenced structures: Output_Agent, Output_ItemReferenceType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemReferenceType"
},
{
"type": "null"
}
]
}
},
"required": [
"id"
],
"type": "object"
}Output_ItemReferenceType
Complete JSON Schema
{
"enum": [
"item_reference"
],
"type": "string"
}Output_ItemStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete"
],
"type": "string"
}Output_IterationUsage
Complete JSON Schema
Referenced structures: Output_AdvisorMessageIterationUsage, Output_CompactionIterationUsage, Output_FallbackMessageIterationUsage, Output_MessageIterationUsage
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_MessageIterationUsage"
},
{
"$ref": "#/components/schemas/Output_CompactionIterationUsage"
},
{
"$ref": "#/components/schemas/Output_AdvisorMessageIterationUsage"
},
{
"$ref": "#/components/schemas/Output_FallbackMessageIterationUsage"
}
]
}Output_JsonSchema
Complete JSON Schema
Referenced structures: Output_JsonSchemaType
{
"additionalProperties": true,
"properties": {
"$anchor": {
"type": [
"string",
"null"
]
},
"$comment": {
"type": [
"string",
"null"
]
},
"$defs": true,
"$dynamicAnchor": {
"type": [
"string",
"null"
]
},
"$dynamicRef": {
"type": [
"string",
"null"
]
},
"$id": {
"type": [
"string",
"null"
]
},
"$ref": {
"type": [
"string",
"null"
]
},
"$schema": {
"type": [
"string",
"null"
]
},
"additionalProperties": true,
"allOf": {
"items": true,
"type": [
"array",
"null"
]
},
"anyOf": {
"items": true,
"type": [
"array",
"null"
]
},
"const": true,
"default": true,
"definitions": true,
"dependencies": true,
"dependentRequired": true,
"dependentSchemas": true,
"deprecated": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"else": true,
"enum": {
"items": true,
"type": [
"array",
"null"
]
},
"examples": {
"items": true,
"type": [
"array",
"null"
]
},
"if": true,
"maxProperties": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"minProperties": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"not": true,
"oneOf": {
"items": true,
"type": [
"array",
"null"
]
},
"patternProperties": true,
"properties": true,
"propertyNames": true,
"readOnly": {
"type": [
"boolean",
"null"
]
},
"required": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"then": true,
"title": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_JsonSchemaType"
},
"unevaluatedProperties": true,
"writeOnly": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"type"
],
"type": "object"
}Output_JsonSchemaType
Complete JSON Schema
{
"enum": [
"object"
],
"type": "string"
}Output_KeypressAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"keys"
],
"type": "object"
}Output_Language
Complete JSON Schema
{
"enum": [
"LANGUAGE_UNSPECIFIED",
"PYTHON"
],
"type": "string"
}Output_ListFilesResponseBody
Complete JSON Schema
Referenced structures: Output_FileObject
{
"additionalProperties": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Output_FileObject"
},
"type": "array"
},
"first_id": {
"type": "string"
},
"has_more": {
"type": "boolean"
},
"last_id": {
"type": "string"
},
"object": {
"type": "string"
}
},
"required": [
"object",
"data",
"has_more",
"first_id",
"last_id"
],
"type": "object"
}Output_ListFilesResponseBody2
Complete JSON Schema
Referenced structures: Output_FileMetadata
{
"additionalProperties": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Output_FileMetadata"
},
"type": "array"
},
"first_id": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": [
"boolean",
"null"
]
},
"last_id": {
"type": [
"string",
"null"
]
},
"next_page": {
"type": [
"string",
"null"
]
}
},
"required": [
"data"
],
"type": "object"
}Output_ListFilesResponseBody3
Complete JSON Schema
Referenced structures: Output_File
{
"additionalProperties": true,
"properties": {
"files": {
"items": {
"$ref": "#/components/schemas/Output_File"
},
"type": [
"array",
"null"
]
},
"nextPageToken": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ListModelsResponseBody
Complete JSON Schema
Referenced structures: Output_ListObject, Output_Model
{
"additionalProperties": true,
"properties": {
"data": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_Model"
},
"type": "array"
},
"models": {
"items": {
"$ref": "#/components/schemas/Output_Model"
},
"type": [
"array",
"null"
]
},
"object": {
"$ref": "#/components/schemas/Output_ListObject",
"default": "list"
}
},
"required": [
"data",
"object"
],
"type": "object"
}Output_ListModelsResponseBody2
Complete JSON Schema
Referenced structures: Output_ModelInfo
{
"additionalProperties": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Output_ModelInfo"
},
"type": "array"
},
"first_id": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"last_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"data",
"first_id",
"has_more",
"last_id"
],
"type": "object"
}Output_ListModelsResponseBody3
Complete JSON Schema
Referenced structures: Output_Model2
{
"additionalProperties": true,
"properties": {
"models": {
"items": {
"$ref": "#/components/schemas/Output_Model2"
},
"type": [
"array",
"null"
]
},
"nextPageToken": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ListObject
Complete JSON Schema
{
"enum": [
"list"
],
"type": "string"
}Output_LiveAllowedClientEvents
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}Output_LiveAllowedServerEvents
Complete JSON Schema
Referenced structures: Output_LiveServerEventSelector
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Output_LiveServerEventSelector"
},
"type": "array"
}
]
}Output_LiveAudio
Complete JSON Schema
Referenced structures: Output_LiveAudioInput, Output_LiveAudioOutput
{
"additionalProperties": true,
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveAudioInput"
},
{
"type": "null"
}
]
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveAudioOutput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_LiveAudioFormat
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"rate": {
"format": "uint32",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Output_LiveAudioInput
Complete JSON Schema
Referenced structures: Output_LiveAudioFormat
{
"additionalProperties": true,
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveAudioFormat"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_LiveAudioOutput
Complete JSON Schema
Referenced structures: Output_LiveAudioFormat, Output_LiveVoice
{
"additionalProperties": true,
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveAudioFormat"
},
{
"type": "null"
}
]
},
"voice": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveVoice"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_LiveBlob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"data": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": [
"string",
"null"
]
},
"mimeType": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_LiveClientConfig
Complete JSON Schema
Referenced structures: Output_LiveDataChannelConfig
{
"additionalProperties": true,
"properties": {
"data_channel": {
"$ref": "#/components/schemas/Output_LiveDataChannelConfig"
}
},
"required": [
"data_channel"
],
"type": "object"
}Output_LiveContent
Complete JSON Schema
Referenced structures: Output_LivePart
{
"additionalProperties": true,
"properties": {
"parts": {
"items": {
"$ref": "#/components/schemas/Output_LivePart"
},
"type": [
"array",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_LiveDataChannelConfig
Complete JSON Schema
Referenced structures: Output_LiveAllowedClientEvents, Output_LiveAllowedServerEvents
{
"additionalProperties": true,
"properties": {
"allowed_client_events": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveAllowedClientEvents"
},
{
"type": "null"
}
]
},
"allowed_server_events": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveAllowedServerEvents"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_LiveDecisionResult
Complete JSON Schema
Referenced structures: Output_DecisionAnswer, Output_ResponseUsage
{
"additionalProperties": true,
"properties": {
"answers": {
"items": {
"$ref": "#/components/schemas/Output_DecisionAnswer"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"model": {
"type": "string"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"model",
"answers"
],
"type": "object"
}Output_LiveDecisionStreamEvent
Complete JSON Schema
Referenced structures: Output_LiveDecisionResult
{
"additionalProperties": true,
"properties": {
"decision": {
"$ref": "#/components/schemas/Output_LiveDecisionResult"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"decision"
],
"type": "object"
}Output_LiveDecisionTrigger
Complete JSON Schema
Referenced structures: Output_LiveTriggerEvent, Output_LiveTriggerQuestions, Output_LiveTriggerType
{
"additionalProperties": true,
"properties": {
"decisions": {
"$ref": "#/components/schemas/Output_LiveTriggerQuestions"
},
"event_type": {
"$ref": "#/components/schemas/Output_LiveTriggerEvent"
},
"type": {
"$ref": "#/components/schemas/Output_LiveTriggerType"
}
},
"required": [
"type",
"event_type",
"decisions"
],
"type": "object"
}Output_LiveDecisionsConfig
Complete JSON Schema
Referenced structures: Output_DecisionQuestion
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
},
"questions": {
"items": {
"$ref": "#/components/schemas/Output_DecisionQuestion"
},
"type": "array"
}
},
"required": [
"model",
"questions"
],
"type": "object"
}Output_LiveDelegatedEvent
Complete JSON Schema
Referenced structures: Output_LiveDecisionStreamEvent, Output_StreamEvent
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveDecisionStreamEvent"
},
{
"$ref": "#/components/schemas/Output_StreamEvent"
},
true
]
}Output_LiveDelegation
Complete JSON Schema
Referenced structures: Output_LiveDecisionsConfig, Output_LiveResponsesConfig
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"type": {
"const": "client",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"responses": {
"$ref": "#/components/schemas/Output_LiveResponsesConfig"
},
"type": {
"const": "responses",
"type": "string"
}
},
"required": [
"type",
"responses"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"decisions": {
"$ref": "#/components/schemas/Output_LiveDecisionsConfig"
},
"type": {
"const": "decisions",
"type": "string"
}
},
"required": [
"type",
"decisions"
],
"type": "object"
}
]
}Output_LiveInt64
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"format": "int64",
"type": "integer"
}
],
"description": "ProtoJSON int64 fields allow decimal strings and numeric JSON inputs."
}Output_LivePart
Complete JSON Schema
Referenced structures: Output_BidiGenerateContentTranscription, Output_CodeExecutionResult2, Output_ExecutableCode, Output_FileData, Output_FunctionCall2, Output_FunctionResponse, Output_LiveBlob, Output_MediaProcessing, Output_MediaResolution, Output_SpeechMetadata, Output_ToolCall, Output_ToolResponse, Output_VideoMetadata
{
"additionalProperties": true,
"properties": {
"audioTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentTranscription"
},
{
"type": "null"
}
]
},
"codeExecutionResult": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CodeExecutionResult2"
},
{
"type": "null"
}
]
},
"executableCode": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ExecutableCode"
},
{
"type": "null"
}
]
},
"fileData": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileData"
},
{
"type": "null"
}
]
},
"functionCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FunctionCall2"
},
{
"type": "null"
}
]
},
"functionResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FunctionResponse"
},
{
"type": "null"
}
]
},
"inlineData": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveBlob"
},
{
"type": "null"
}
]
},
"mediaProcessing": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MediaProcessing"
},
{
"type": "null"
}
]
},
"mediaResolution": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MediaResolution"
},
{
"type": "null"
}
]
},
"partMetadata": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"speechMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SpeechMetadata"
},
{
"type": "null"
}
]
},
"text": {
"type": [
"string",
"null"
]
},
"thought": {
"type": [
"boolean",
"null"
]
},
"thoughtSignature": {
"type": [
"string",
"null"
]
},
"toolCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolCall"
},
{
"type": "null"
}
]
},
"toolResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolResponse"
},
{
"type": "null"
}
]
},
"videoMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VideoMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_LiveResponseTransport
Complete JSON Schema
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"sdp": {
"type": "string"
},
"type": {
"const": "webrtc",
"type": "string"
}
},
"required": [
"type",
"sdp"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"type": {
"const": "sip",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_LiveResponsesConfig
Complete JSON Schema
Referenced structures: Output_ReasoningConfig, Output_Tool
{
"additionalProperties": true,
"properties": {
"instructions": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"model": {
"type": "string"
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningConfig"
},
{
"type": "null"
}
]
},
"service_tier": {
"type": [
"string",
"null"
]
},
"text": true,
"tool_choice": true,
"tools": {
"items": {
"$ref": "#/components/schemas/Output_Tool"
},
"type": [
"array",
"null"
]
}
},
"required": [
"model"
],
"type": "object"
}Output_LiveServerEvent
Complete JSON Schema
Referenced structures: Output_LiveDelegatedEvent, Output_LiveSessionConfig, Output_LiveSessionUsage
{
"additionalProperties": true,
"properties": {
"delegation_id": {
"type": [
"string",
"null"
]
},
"event": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveDelegatedEvent"
},
{
"type": "null"
}
]
},
"event_id": {
"type": [
"string",
"null"
]
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveSessionConfig"
},
{
"type": "null"
}
]
},
"session_id": {
"type": [
"string",
"null"
]
},
"source_event_id": {
"type": [
"string",
"null"
]
},
"source_event_type": {
"type": [
"string",
"null"
]
},
"trigger_id": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveSessionUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"type"
],
"type": "object"
}Output_LiveServerEventSelector
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"response_event": true,
"type": {
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}Output_LiveServerMessage
Complete JSON Schema
Referenced structures: Output_BidiGenerateContentServerContent, Output_BidiGenerateContentSetupComplete, Output_BidiGenerateContentToolCall, Output_BidiGenerateContentToolCallCancellation, Output_GoAway, Output_LiveUsageMetadata, Output_SessionResumptionUpdate, Output_VoiceActivity, Output_VoiceActivityDetectionSignal
{
"additionalProperties": true,
"properties": {
"goAway": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GoAway"
},
{
"type": "null"
}
]
},
"serverContent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentServerContent"
},
{
"type": "null"
}
]
},
"sessionResumptionUpdate": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SessionResumptionUpdate"
},
{
"type": "null"
}
]
},
"setupComplete": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentSetupComplete"
},
{
"type": "null"
}
]
},
"toolCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentToolCall"
},
{
"type": "null"
}
]
},
"toolCallCancellation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BidiGenerateContentToolCallCancellation"
},
{
"type": "null"
}
]
},
"usageMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveUsageMetadata"
},
{
"type": "null"
}
]
},
"voiceActivity": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VoiceActivity"
},
{
"type": "null"
}
]
},
"voiceActivityDetectionSignal": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VoiceActivityDetectionSignal"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_LiveSessionConfig
Complete JSON Schema
Referenced structures: Output_LiveAudio, Output_LiveClientConfig, Output_LiveDecisionTrigger, Output_LiveDelegation
{
"additionalProperties": true,
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveAudio"
},
{
"type": "null"
}
]
},
"client": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveClientConfig"
},
{
"type": "null"
}
]
},
"delegation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveDelegation"
},
{
"type": "null"
}
]
},
"initial_items": {
"items": true,
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"model": {
"type": "string"
},
"triggers": {
"items": {
"$ref": "#/components/schemas/Output_LiveDecisionTrigger"
},
"type": [
"array",
"null"
]
}
},
"required": [
"model"
],
"type": "object"
}Output_LiveSessionId
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Output_LiveSessionUsage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"seconds": {
"format": "double",
"type": "number"
}
},
"required": [
"seconds"
],
"type": "object"
}Output_LiveTriggerEvent
Complete JSON Schema
{
"enum": [
"session.input_transcript.delta",
"session.output_transcript.delta"
],
"type": "string"
}Output_LiveTriggerQuestions
Complete JSON Schema
Referenced structures: Output_DecisionQuestion
{
"additionalProperties": true,
"properties": {
"questions": {
"items": {
"$ref": "#/components/schemas/Output_DecisionQuestion"
},
"type": "array"
}
},
"required": [
"questions"
],
"type": "object"
}Output_LiveTriggerType
Complete JSON Schema
{
"enum": [
"decisions"
],
"type": "string"
}Output_LiveUsageMetadata
Complete JSON Schema
Referenced structures: Output_ModalityTokenCount, Output_ServiceTier2
{
"additionalProperties": true,
"properties": {
"cacheTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"cachedContentTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"promptTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"promptTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"responseTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"responseTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"serviceTier": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ServiceTier2"
},
{
"type": "null"
}
]
},
"thoughtsTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"toolUsePromptTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"toolUsePromptTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"totalTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_LiveVoice
Complete JSON Schema
Referenced structures: Output_CustomVoice
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Output_CustomVoice"
}
]
}Output_LocalShellAction
Complete JSON Schema
Referenced structures: Output_LocalShellActionType
{
"additionalProperties": true,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"env": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_LocalShellActionType"
},
"user": {
"type": [
"string",
"null"
]
},
"working_directory": {
"type": [
"string",
"null"
]
}
},
"required": [
"command",
"env",
"type"
],
"type": "object"
}Output_LocalShellActionType
Complete JSON Schema
{
"enum": [
"exec"
],
"type": "string"
}Output_LocalShellCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_ItemStatus, Output_LocalShellAction, Output_LocalShellCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Output_LocalShellAction"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Output_LocalShellCallType"
}
},
"required": [
"type",
"id",
"call_id",
"action",
"status"
],
"type": "object"
}Output_LocalShellCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ItemStatus, Output_LocalShellCallOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"output": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_LocalShellCallOutputType"
}
},
"required": [
"type",
"id",
"output"
],
"type": "object"
}Output_LocalShellCallOutputType
Complete JSON Schema
{
"enum": [
"local_shell_call_output"
],
"type": "string"
}Output_LocalShellCallType
Complete JSON Schema
{
"enum": [
"local_shell_call"
],
"type": "string"
}Output_LocalSkill
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"path": {
"type": "string"
}
},
"required": [
"description",
"name",
"path"
],
"type": "object"
}Output_LogBodyDto
Complete JSON Schema
Referenced structures: Output_LogBodyEncoding
{
"description": "One captured body, or the reason there is none.",
"properties": {
"bytes": {
"description": "Reconstructed body bytes, not the length of `content`.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"content": {
"type": "string"
},
"encoding": {
"$ref": "#/components/schemas/Output_LogBodyEncoding"
},
"state": {
"description": "The record's own `body_state`: `not_captured`, `recording`,\n`complete`, `partial` or `failed`. `not_captured` with zero bytes is a\nbody nobody stored; `complete` with zero bytes is a body that was\ngenuinely empty.",
"type": "string"
},
"truncated": {
"description": "Compatibility field: false, because reads return the complete stored payload.",
"type": "boolean"
}
},
"required": [
"state",
"encoding",
"truncated",
"bytes",
"content"
],
"type": "object"
}Output_LogBodyEncoding
Complete JSON Schema
{
"description": "How a body's bytes are spelled in `content`.",
"oneOf": [
{
"const": "utf8",
"description": "Valid UTF-8.",
"type": "string"
},
{
"const": "base64",
"description": "Standard base64 with padding, for bytes that are not text.",
"type": "string"
}
]
}Output_LogDetailDto
Complete JSON Schema
Referenced structures: Output_CaptureEventDto, Output_CaptureRecordDto, Output_UsageRecordDto
{
"description": "One request and everything captured under it.",
"properties": {
"downstream": {
"$ref": "#/components/schemas/Output_CaptureRecordDto"
},
"events": {
"description": "The events of the downstream record and of every upstream one,\nordered by capture and then by sequence.",
"items": {
"$ref": "#/components/schemas/Output_CaptureEventDto"
},
"type": "array"
},
"eventsTruncated": {
"description": "True when the event cap cut the list short.",
"type": "boolean"
},
"upstream": {
"description": "Every associated upstream call, ordered by start time, attempt ordinal and ID.\nA retry is another entry here, not another downstream record.",
"items": {
"$ref": "#/components/schemas/Output_CaptureRecordDto"
},
"type": "array"
},
"usage": {
"description": "Usage of associated physical upstream calls, retained independently of captures.",
"items": {
"$ref": "#/components/schemas/Output_UsageRecordDto"
},
"type": "array"
}
},
"required": [
"downstream",
"upstream",
"events",
"eventsTruncated",
"usage"
],
"type": "object"
}Output_LogEntryDto
Complete JSON Schema
{
"description": "One downstream request or physical upstream exchange, as a list row.",
"properties": {
"apiKeyId": {
"type": [
"string",
"null"
]
},
"clientIp": {
"type": [
"string",
"null"
]
},
"credentialId": {
"type": [
"string",
"null"
]
},
"endedAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"error": {
"type": [
"string",
"null"
]
},
"firstResponseAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"kind": {
"description": "`http`, `ws_connection` or `ws_turn`.",
"type": "string"
},
"model": {
"type": [
"string",
"null"
]
},
"operation": {
"type": [
"string",
"null"
]
},
"providerId": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"requestId": {
"description": "Capture ID. For downstream rows this is also the request ID;\nupstream rows have their own physical exchange ID.",
"type": "string"
},
"requestMethod": {
"type": [
"string",
"null"
]
},
"requestUrl": {
"type": [
"string",
"null"
]
},
"responseStatus": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"sessionId": {
"type": [
"string",
"null"
]
},
"startedAtMs": {
"format": "int64",
"type": "integer"
},
"state": {
"description": "`in_progress`, `completed`, `failed` or `cancelled`. Capture\ncompleteness, not the upstream's verdict.",
"type": "string"
},
"userId": {
"type": [
"string",
"null"
]
}
},
"required": [
"requestId",
"kind",
"sessionId",
"userId",
"apiKeyId",
"providerId",
"credentialId",
"model",
"operation",
"requestMethod",
"requestUrl",
"responseStatus",
"state",
"error",
"reason",
"clientIp",
"startedAtMs",
"firstResponseAtMs",
"endedAtMs"
],
"type": "object"
}Output_LogPageDto
Complete JSON Schema
Referenced structures: Output_LogEntryDto
{
"description": "One page of the request list, plus where the next one starts.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_LogEntryDto"
},
"type": "array"
},
"nextCursor": {
"description": "The `started_at_ms` of the last item, or None at the end of the list.\nHand both cursor halves back unchanged to get the next page.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"nextCursorId": {
"description": "The id of the same item. Two requests can share a millisecond, and a\ntimestamp-only cursor would either repeat them forever or skip them;\nthe pair is unique because ids are.",
"type": [
"string",
"null"
]
}
},
"required": [
"items",
"nextCursor",
"nextCursorId"
],
"type": "object"
}Output_LogProbProperties
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/log_prob_properties.py`, `LogProbProperties`.",
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"logprob": {
"type": "number"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"bytes",
"logprob"
],
"type": "object"
}Output_LoggingSettingsDto
Complete JSON Schema
{
"properties": {
"disableLogRedaction": {
"type": "boolean"
},
"enableDownstreamLog": {
"type": "boolean"
},
"enableDownstreamLogBody": {
"type": "boolean"
},
"enableTracing": {
"type": "boolean"
},
"enableUpstreamLog": {
"type": "boolean"
},
"enableUpstreamLogBody": {
"type": "boolean"
},
"logFormat": {
"type": "string"
},
"logLevel": {
"type": "string"
},
"queryParameterBlacklist": true,
"requestHeaderBlacklist": true,
"responseHeaderBlacklist": true
},
"required": [
"enableDownstreamLog",
"enableDownstreamLogBody",
"enableUpstreamLog",
"enableUpstreamLogBody",
"disableLogRedaction",
"enableTracing",
"logLevel",
"logFormat",
"requestHeaderBlacklist",
"responseHeaderBlacklist",
"queryParameterBlacklist"
],
"type": "object"
}Output_LoginMode
Complete JSON Schema
{
"description": "How a credential for this channel comes into existence.",
"oneOf": [
{
"const": "authorization_code",
"description": "Browser redirect with PKCE; `OAuthAuthorizationCode`.",
"type": "string"
},
{
"const": "device_code",
"description": "User code shown, host polls; `OAuthDeviceCode`.",
"type": "string"
},
{
"const": "api_key",
"description": "A key the operator pastes. No channel trait is involved: the secret is\nstored as given and the channel injects it at request time.",
"type": "string"
}
]
}Output_LogprobCandidate
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"logProbability": {
"format": "double",
"type": [
"number",
"null"
]
},
"token": {
"type": [
"string",
"null"
]
},
"tokenId": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_Logprobs
Complete JSON Schema
Referenced structures: Output_TokenLogprob
{
"additionalProperties": true,
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_TokenLogprob"
},
"type": [
"array",
"null"
]
},
"refusal": {
"items": {
"$ref": "#/components/schemas/Output_TokenLogprob"
},
"type": [
"array",
"null"
]
}
},
"required": [
"content",
"refusal"
],
"type": "object"
}Output_LogprobsResult
Complete JSON Schema
Referenced structures: Output_LogprobCandidate, Output_TopCandidates
{
"additionalProperties": true,
"properties": {
"chosenCandidates": {
"items": {
"$ref": "#/components/schemas/Output_LogprobCandidate"
},
"type": [
"array",
"null"
]
},
"logProbabilitySum": {
"format": "double",
"type": [
"number",
"null"
]
},
"topCandidates": {
"items": {
"$ref": "#/components/schemas/Output_TopCandidates"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_Maps
Complete JSON Schema
Referenced structures: Output_PlaceAnswerSources
{
"additionalProperties": true,
"properties": {
"placeAnswerSources": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PlaceAnswerSources"
},
{
"type": "null"
}
]
},
"placeId": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"uri": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_McpAllowedTools
Complete JSON Schema
Referenced structures: Output_McpToolFilter
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Output_McpToolFilter"
}
]
}Output_McpApproval
Complete JSON Schema
Referenced structures: Output_McpApprovalSetting, Output_McpToolApprovalFilter
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpApprovalSetting"
},
{
"$ref": "#/components/schemas/Output_McpToolApprovalFilter"
}
]
}Output_McpApprovalRequest
Complete JSON Schema
Referenced structures: Output_Agent, Output_McpApprovalRequestType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_McpApprovalRequestType"
}
},
"required": [
"type",
"id",
"arguments",
"name",
"server_label"
],
"type": "object"
}Output_McpApprovalRequestType
Complete JSON Schema
{
"enum": [
"mcp_approval_request"
],
"type": "string"
}Output_McpApprovalResponse
Complete JSON Schema
Referenced structures: Output_Agent, Output_McpApprovalResponseType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"approval_request_id": {
"type": "string"
},
"approve": {
"type": "boolean"
},
"id": {
"type": [
"string",
"null"
]
},
"reason": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_McpApprovalResponseType"
}
},
"required": [
"type",
"approval_request_id",
"approve"
],
"type": "object"
}Output_McpApprovalResponseType
Complete JSON Schema
{
"enum": [
"mcp_approval_response"
],
"type": "string"
}Output_McpApprovalSetting
Complete JSON Schema
{
"enum": [
"always",
"never"
],
"type": "string"
}Output_McpArgumentsDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"delta"
],
"type": "object"
}Output_McpArgumentsDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"arguments"
],
"type": "object"
}Output_McpCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_McpCallStatus, Output_McpCallType, Output_McpToolCallError
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"approval_request_id": {
"type": [
"string",
"null"
]
},
"arguments": {
"type": "string"
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpToolCallError"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"output": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpCallStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_McpCallType"
}
},
"required": [
"type",
"id",
"arguments",
"name",
"server_label"
],
"type": "object"
}Output_McpCallEvent
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index"
],
"type": "object"
}Output_McpCallStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete",
"calling",
"failed"
],
"type": "string"
}Output_McpCallType
Complete JSON Schema
{
"enum": [
"mcp_call"
],
"type": "string"
}Output_McpListTools
Complete JSON Schema
Referenced structures: Output_Agent, Output_McpListToolsType, Output_McpToolDefinition
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"error": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"server_label": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_McpToolDefinition"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_McpListToolsType"
}
},
"required": [
"type",
"id",
"server_label",
"tools"
],
"type": "object"
}Output_McpListToolsCompleted
Complete JSON Schema
Referenced structures: Output_McpListToolsCompletedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/mcp_list_tools_completed.py`, `McpListToolsCompleted`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_McpListToolsCompletedType"
}
},
"required": [
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_McpListToolsCompletedType
Complete JSON Schema
{
"enum": [
"mcp_list_tools.completed"
],
"type": "string"
}Output_McpListToolsEvent
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index"
],
"type": "object"
}Output_McpListToolsFailed
Complete JSON Schema
Referenced structures: Output_McpListToolsFailedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/mcp_list_tools_failed.py`, `McpListToolsFailed`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_McpListToolsFailedType"
}
},
"required": [
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_McpListToolsFailedType
Complete JSON Schema
{
"enum": [
"mcp_list_tools.failed"
],
"type": "string"
}Output_McpListToolsInProgress
Complete JSON Schema
Referenced structures: Output_McpListToolsInProgressType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/mcp_list_tools_in_progress.py`, `McpListToolsInProgress`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_McpListToolsInProgressType"
}
},
"required": [
"event_id",
"item_id",
"type"
],
"type": "object"
}Output_McpListToolsInProgressType
Complete JSON Schema
{
"enum": [
"mcp_list_tools.in_progress"
],
"type": "string"
}Output_McpListToolsType
Complete JSON Schema
{
"enum": [
"mcp_list_tools"
],
"type": "string"
}Output_McpListedTool
Complete JSON Schema
Referenced structures: Output_JsonSchema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"input_schema": {
"$ref": "#/components/schemas/Output_JsonSchema"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"input_schema"
],
"type": "object"
}Output_McpResourceToolMessages
Complete JSON Schema
Referenced structures: Output_ToolMessage
{
"additionalProperties": true,
"properties": {
"list_mcp_resource_templates": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"list_mcp_resources": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"read_mcp_resource": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_McpTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller, Output_ConnectorId, Output_McpAllowedTools, Output_McpApproval
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"allowed_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpAllowedTools"
},
{
"type": "null"
}
]
},
"authorization": {
"type": [
"string",
"null"
]
},
"connector_id": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConnectorId"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"require_approval": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpApproval"
},
{
"type": "null"
}
]
},
"server_description": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"server_url": {
"type": [
"string",
"null"
]
},
"tunnel_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"server_label"
],
"type": "object"
}Output_McpToolApprovalFilter
Complete JSON Schema
Referenced structures: Output_McpToolFilter
{
"additionalProperties": true,
"properties": {
"always": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpToolFilter"
},
{
"type": "null"
}
]
},
"never": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpToolFilter"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_McpToolCallError
Complete JSON Schema
Referenced structures: Output_McpToolCallErrorDetails
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpToolCallErrorDetails"
},
{
"description": "Earlier Responses references represented MCP errors as strings.",
"type": "string"
}
]
}Output_McpToolCallErrorDetails
Complete JSON Schema
{
"oneOf": [
{
"additionalProperties": true,
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"const": "mcp_protocol_error",
"type": "string"
}
},
"required": [
"type",
"code",
"message"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"content": true,
"type": {
"const": "mcp_tool_execution_error",
"type": "string"
}
},
"required": [
"type",
"content"
],
"type": "object"
},
{
"additionalProperties": true,
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"const": "http_error",
"type": "string"
}
},
"required": [
"type",
"code",
"message"
],
"type": "object"
}
]
}Output_McpToolDefinition
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"annotations": true,
"description": {
"type": [
"string",
"null"
]
},
"input_schema": true,
"name": {
"type": "string"
}
},
"required": [
"name",
"input_schema"
],
"type": "object"
}Output_McpToolFilter
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_McpToolListingBlock
Complete JSON Schema
Referenced structures: Output_CacheControl, Output_McpListedTool, Output_McpToolListingType
{
"additionalProperties": true,
"properties": {
"cache_control": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheControl"
},
{
"type": "null"
}
]
},
"mcp_server_name": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_McpListedTool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_McpToolListingType"
}
},
"required": [
"type",
"mcp_server_name",
"tools"
],
"type": "object"
}Output_McpToolListingType
Complete JSON Schema
{
"enum": [
"mcp_tool_listing"
],
"type": "string"
}Output_MediaProcessing
Complete JSON Schema
{
"enum": [
"MEDIA_PROCESSING_UNSPECIFIED",
"STATIC",
"AGENTIC"
],
"type": "string"
}Output_MediaResolution
Complete JSON Schema
Referenced structures: Output_MediaResolutionLevel
{
"additionalProperties": true,
"properties": {
"level": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MediaResolutionLevel"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_MediaResolutionLevel
Complete JSON Schema
{
"enum": [
"MEDIA_RESOLUTION_UNSPECIFIED",
"MEDIA_RESOLUTION_LOW",
"MEDIA_RESOLUTION_MEDIUM",
"MEDIA_RESOLUTION_HIGH",
"MEDIA_RESOLUTION_ULTRA_HIGH"
],
"type": "string"
}Output_MemoryLimit
Complete JSON Schema
{
"enum": [
"1g",
"4g",
"16g",
"64g"
],
"type": "string"
}Output_MemorySummarizeOutput
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"memory_summary": {
"type": "string"
},
"trace_summary": {
"type": "string"
}
},
"required": [
"trace_summary",
"memory_summary"
],
"type": "object"
}Output_MemorySummarizeResponseBody
Complete JSON Schema
Referenced structures: Output_MemorySummarizeOutput
{
"additionalProperties": true,
"properties": {
"output": {
"items": {
"$ref": "#/components/schemas/Output_MemorySummarizeOutput"
},
"type": "array"
}
},
"required": [
"output"
],
"type": "object"
}Output_MessageContent
Complete JSON Schema
Referenced structures: Output_InputContent
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Output_InputContent"
},
"type": "array"
}
]
}Output_MessageDelta
Complete JSON Schema
Referenced structures: Output_RefusalStopDetails, Output_ResponseContainer, Output_StopReason
{
"additionalProperties": true,
"properties": {
"container": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseContainer"
},
{
"type": "null"
}
]
},
"stop_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RefusalStopDetails"
},
{
"type": "null"
}
]
},
"stop_reason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_StopReason"
},
{
"type": "null"
}
]
},
"stop_sequence": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_MessageDeltaEvent
Complete JSON Schema
Referenced structures: Output_ContextManagementResponse, Output_InputTransformation, Output_MessageDelta, Output_MessageDeltaUsage
{
"additionalProperties": true,
"properties": {
"context_management": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ContextManagementResponse"
},
{
"type": "null"
}
]
},
"delta": {
"$ref": "#/components/schemas/Output_MessageDelta"
},
"input_transformations": {
"items": {
"$ref": "#/components/schemas/Output_InputTransformation"
},
"type": [
"array",
"null"
]
},
"usage": {
"$ref": "#/components/schemas/Output_MessageDeltaUsage"
}
},
"required": [
"delta",
"usage"
],
"type": "object"
}Output_MessageDeltaUsage
Complete JSON Schema
Referenced structures: Output_FallbackCreditUsage, Output_IterationUsage, Output_OutputTokensDetails, Output_ServerToolUsage
{
"additionalProperties": true,
"properties": {
"cache_creation_input_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cache_read_input_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"fallback_credit": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FallbackCreditUsage"
},
{
"type": "null"
}
]
},
"input_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"iterations": {
"items": {
"$ref": "#/components/schemas/Output_IterationUsage"
},
"type": [
"array",
"null"
]
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_OutputTokensDetails"
},
{
"type": "null"
}
]
},
"server_tool_use": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ServerToolUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"output_tokens"
],
"type": "object"
}Output_MessageIterationUsage
Complete JSON Schema
Referenced structures: Output_CacheCreation, Output_MessageIterationUsageType
{
"additionalProperties": true,
"properties": {
"cache_creation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheCreation"
},
{
"type": "null"
}
]
},
"cache_creation_input_tokens": {
"format": "int64",
"type": "integer"
},
"cache_read_input_tokens": {
"format": "int64",
"type": "integer"
},
"input_tokens": {
"format": "int64",
"type": "integer"
},
"model": {
"type": "string"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_MessageIterationUsageType"
}
},
"required": [
"type",
"cache_creation_input_tokens",
"cache_read_input_tokens",
"input_tokens",
"model",
"output_tokens"
],
"type": "object"
}Output_MessageIterationUsageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Output_MessagePhase
Complete JSON Schema
{
"enum": [
"commentary",
"final_answer"
],
"type": "string"
}Output_MessageRole
Complete JSON Schema
{
"enum": [
"user",
"system",
"developer",
"assistant"
],
"type": "string"
}Output_MessageStartEvent
Complete JSON Schema
Referenced structures: Output_StreamMessage
{
"additionalProperties": true,
"properties": {
"message": {
"$ref": "#/components/schemas/Output_StreamMessage"
}
},
"required": [
"message"
],
"type": "object"
}Output_MessageStopEvent
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_MessageToolCall
Complete JSON Schema
Referenced structures: Output_ChatToolCall, Output_CustomToolCall2
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ChatToolCall"
},
{
"$ref": "#/components/schemas/Output_CustomToolCall2"
}
]
}Output_MessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Output_MisalignmentDetails
Complete JSON Schema
Referenced structures: Output_MisalignmentSteer
{
"additionalProperties": true,
"properties": {
"detailed_explanation": {
"type": [
"string",
"null"
]
},
"error_type": {
"type": [
"string",
"null"
]
},
"steer": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MisalignmentSteer"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_MisalignmentSteer
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
}Output_Modality
Complete JSON Schema
{
"enum": [
"MODALITY_UNSPECIFIED",
"TEXT",
"IMAGE",
"VIDEO",
"AUDIO",
"DOCUMENT"
],
"type": "string"
}Output_ModalityTokenCount
Complete JSON Schema
Referenced structures: Output_Modality
{
"additionalProperties": true,
"properties": {
"modality": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Modality"
},
{
"type": "null"
}
]
},
"tokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_Model
Complete JSON Schema
Referenced structures: Output_ApplyPatchToolType, Output_ClientVersion, Output_ConfigShellToolType, Output_GuardianModelPolicy, Output_ModelAccessPrograms, Output_ModelAvailabilityNux, Output_ModelInfoUpgrade, Output_ModelMessages, Output_ModelObject, Output_ModelReasoningEffort, Output_ModelReasoningLevel, Output_ModelReasoningSummary, Output_ModelServiceTier, Output_ModelVisibility, Output_MultiAgentVersion, Output_TextVerbosity, Output_ToolMode, Output_TruncationPolicyConfig, Output_WebSearchToolType
{
"additionalProperties": true,
"properties": {
"additional_speed_tiers": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"apply_patch_tool_type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ApplyPatchToolType"
},
{
"type": "null"
}
]
},
"auto_compact_token_limit": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"auto_review_model_override": {
"type": [
"string",
"null"
]
},
"availability_nux": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelAvailabilityNux"
},
{
"type": "null"
}
]
},
"available_access_programs": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelAccessPrograms"
},
{
"type": "null"
}
]
},
"available_in_plans": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"base_instructions": {
"type": [
"string",
"null"
]
},
"comp_hash": {
"type": [
"string",
"null"
]
},
"context_window": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"created": {
"description": "Some compatible catalogs do not report a creation timestamp.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"default_reasoning_level": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelReasoningEffort"
},
{
"type": "null"
}
]
},
"default_reasoning_summary": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelReasoningSummary"
},
{
"type": "null"
}
]
},
"default_service_tier": {
"type": [
"string",
"null"
]
},
"default_verbosity": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TextVerbosity"
},
{
"type": "null"
}
]
},
"description": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": [
"string",
"null"
]
},
"effective_context_window_percent": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"experimental_supported_tools": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"generation_methods": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"guardian": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianModelPolicy"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"include_apps_usage_instructions": {
"type": [
"boolean",
"null"
]
},
"include_plugin_usage_instructions": {
"type": [
"boolean",
"null"
]
},
"include_skills_usage_instructions": {
"type": [
"boolean",
"null"
]
},
"input_modalities": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"max_context_window": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"max_output_tokens": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"minimal_client_version": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ClientVersion"
},
{
"type": "null"
}
]
},
"model_messages": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelMessages"
},
{
"type": "null"
}
]
},
"model_specialty": {
"type": [
"string",
"null"
]
},
"multi_agent_reasoning_effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelReasoningEffort"
},
{
"type": "null"
}
]
},
"multi_agent_version": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MultiAgentVersion"
},
{
"type": "null"
}
]
},
"node_repl_auto_review_required": {
"type": [
"boolean",
"null"
]
},
"node_repl_disabled": {
"type": [
"boolean",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelObject"
},
{
"type": "null"
}
]
},
"output_modalities": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"owned_by": {
"type": [
"string",
"null"
]
},
"prefer_websockets": {
"type": [
"boolean",
"null"
]
},
"priority": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"requires_sandboxed_review": {
"type": [
"boolean",
"null"
]
},
"service_tiers": {
"items": {
"$ref": "#/components/schemas/Output_ModelServiceTier"
},
"type": [
"array",
"null"
]
},
"shell_type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConfigShellToolType"
},
{
"type": "null"
}
]
},
"slug": {
"type": [
"string",
"null"
]
},
"support_verbosity": {
"type": [
"boolean",
"null"
]
},
"supported_actions": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"supported_in_api": {
"type": [
"boolean",
"null"
]
},
"supported_parameters": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"supported_reasoning_levels": {
"items": {
"$ref": "#/components/schemas/Output_ModelReasoningLevel"
},
"type": [
"array",
"null"
]
},
"supports_experimental_context": {
"type": [
"boolean",
"null"
]
},
"supports_image_detail_original": {
"type": [
"boolean",
"null"
]
},
"supports_parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"supports_reasoning_effort_updates": {
"type": [
"boolean",
"null"
]
},
"supports_reasoning_summaries": {
"type": [
"boolean",
"null"
]
},
"supports_reasoning_summary_parameter": {
"type": [
"boolean",
"null"
]
},
"supports_search_tool": {
"type": [
"boolean",
"null"
]
},
"thinking_supported": {
"type": [
"boolean",
"null"
]
},
"tool_mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMode"
},
{
"type": "null"
}
]
},
"truncation_policy": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TruncationPolicyConfig"
},
{
"type": "null"
}
]
},
"upgrade": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelInfoUpgrade"
},
{
"type": "null"
}
]
},
"use_responses_lite": {
"type": [
"boolean",
"null"
]
},
"visibility": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelVisibility"
},
{
"type": "null"
}
]
},
"web_search_tool_type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_WebSearchToolType"
},
{
"type": "null"
}
]
}
},
"required": [
"created",
"object",
"owned_by"
],
"type": "object"
}Output_Model2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"baseModelId": {
"type": "string"
},
"description": {
"type": [
"string",
"null"
]
},
"displayName": {
"type": [
"string",
"null"
]
},
"inputTokenLimit": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"maxTemperature": {
"format": "double",
"type": [
"number",
"null"
]
},
"name": {
"type": "string"
},
"outputTokenLimit": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"supportedGenerationMethods": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"temperature": {
"format": "double",
"type": [
"number",
"null"
]
},
"thinking": {
"type": [
"boolean",
"null"
]
},
"topK": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"topP": {
"format": "double",
"type": [
"number",
"null"
]
},
"version": {
"type": "string"
}
},
"required": [
"name",
"baseModelId"
],
"type": "object"
}Output_ModelAccessPrograms
Complete JSON Schema
Referenced structures: Output_CyberAccessProgram
{
"additionalProperties": true,
"properties": {
"cyber": {
"items": {
"$ref": "#/components/schemas/Output_CyberAccessProgram"
},
"type": "array"
}
},
"required": [
"cyber"
],
"type": "object"
}Output_ModelAvailabilityNux
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
}Output_ModelCapabilities
Complete JSON Schema
Referenced structures: Output_CapabilitySupport, Output_CompactionCapability, Output_ContextManagementCapability, Output_EffortCapability, Output_ServerToolsCapability, Output_ThinkingCapability
{
"additionalProperties": true,
"properties": {
"batch": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"citations": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"code_execution": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"compaction": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CompactionCapability"
},
{
"type": "null"
}
]
},
"context_management": {
"$ref": "#/components/schemas/Output_ContextManagementCapability"
},
"effort": {
"$ref": "#/components/schemas/Output_EffortCapability"
},
"image_input": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"pdf_input": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"server_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ServerToolsCapability"
},
{
"type": "null"
}
]
},
"structured_outputs": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"thinking": {
"$ref": "#/components/schemas/Output_ThinkingCapability"
}
},
"required": [
"batch",
"citations",
"code_execution",
"context_management",
"effort",
"image_input",
"pdf_input",
"structured_outputs",
"thinking"
],
"type": "object"
}Output_ModelDto
Complete JSON Schema
Referenced structures: Output_CatalogProviderDto, Output_PriceRuleDto
{
"properties": {
"id": {
"type": "string"
},
"metadata": true,
"name": {
"type": "string"
},
"priceRules": {
"description": "Saved, enabled rules matching this model, in billing precedence order.",
"items": {
"$ref": "#/components/schemas/Output_PriceRuleDto"
},
"type": [
"array",
"null"
]
},
"providers": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_CatalogProviderDto"
},
"type": "array"
},
"vocabularyFileId": {
"type": [
"string",
"null"
]
}
},
"required": [
"providers",
"id",
"name",
"metadata",
"vocabularyFileId"
],
"type": "object"
}Output_ModelInfo
Complete JSON Schema
Referenced structures: Output_ModelCapabilities, Output_ModelLifecycle, Output_ModelType
{
"additionalProperties": true,
"properties": {
"allowed_fallback_models": {
"default": null,
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"capabilities": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelCapabilities"
},
{
"type": "null"
}
]
},
"created_at": {
"type": "string"
},
"deprecated_at": {
"type": [
"string",
"null"
]
},
"display_name": {
"type": "string"
},
"id": {
"type": "string"
},
"lifecycle": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelLifecycle"
},
{
"type": "null"
}
]
},
"line": {
"description": "Provider-reported model line; new lines are allowed without inferring from IDs.",
"type": [
"string",
"null"
]
},
"max_input_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"max_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"retires_at": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ModelType"
}
},
"required": [
"id",
"allowed_fallback_models",
"capabilities",
"created_at",
"display_name",
"max_input_tokens",
"max_tokens",
"type"
],
"type": "object"
}Output_ModelInfoUpgrade
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"migration_markdown": {
"type": "string"
},
"model": {
"type": "string"
},
"retirement_at": {
"type": [
"string",
"null"
]
}
},
"required": [
"model",
"migration_markdown"
],
"type": "object"
}Output_ModelInstructionsVariables
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"personality_default": {
"type": [
"string",
"null"
]
},
"personality_friendly": {
"type": [
"string",
"null"
]
},
"personality_pragmatic": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ModelLifecycle
Complete JSON Schema
{
"description": "The lifecycle is authoritative; a past scheduled retirement date alone does\nnot mean that a model has retired.",
"enum": [
"active",
"deprecated",
"retired"
],
"type": "string"
}Output_ModelMessages
Complete JSON Schema
Referenced structures: Output_ApprovalMessages, Output_AutoReviewMessages, Output_CollaborationModeMessages, Output_ConfirmationPolicies, Output_GuardianV2ModelConfig, Output_ModelInstructionsVariables, Output_ModelTokenBudgetConfig, Output_MultiAgentMessages, Output_PermissionMessages, Output_ToolMessages
{
"additionalProperties": true,
"properties": {
"approvals": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ApprovalMessages"
},
{
"type": "null"
}
]
},
"auto_review": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AutoReviewMessages"
},
{
"type": "null"
}
]
},
"collaboration_modes": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CollaborationModeMessages"
},
{
"type": "null"
}
]
},
"confirmation_policies": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConfirmationPolicies"
},
{
"type": "null"
}
]
},
"content_filter_guidance": {
"type": [
"string",
"null"
]
},
"guardian_v2": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_GuardianV2ModelConfig"
},
{
"type": "null"
}
]
},
"instructions_template": {
"type": [
"string",
"null"
]
},
"instructions_variables": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelInstructionsVariables"
},
{
"type": "null"
}
]
},
"multi_agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MultiAgentMessages"
},
{
"type": "null"
}
]
},
"permissions": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PermissionMessages"
},
{
"type": "null"
}
]
},
"persistent_instructions": {
"type": [
"string",
"null"
]
},
"token_budget": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelTokenBudgetConfig"
},
{
"type": "null"
}
]
},
"tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessages"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ModelObject
Complete JSON Schema
{
"enum": [
"model"
],
"type": "string"
}Output_ModelReasoningEffort
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max",
"ultra",
"persistent"
],
"type": "string"
},
{
"type": "string"
}
],
"description": "Catalog effort choices include CLI modes such as Ultra and Persistent;\nthey are distinct from the Responses request's reasoning-effort parameter."
}Output_ModelReasoningLevel
Complete JSON Schema
Referenced structures: Output_ModelReasoningEffort
{
"properties": {
"description": {
"type": "string"
},
"effort": {
"$ref": "#/components/schemas/Output_ModelReasoningEffort"
}
},
"required": [
"effort",
"description"
],
"type": "object"
}Output_ModelReasoningSummary
Complete JSON Schema
{
"enum": [
"auto",
"concise",
"detailed",
"none"
],
"type": "string"
}Output_ModelServiceTier
Complete JSON Schema
{
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name",
"description"
],
"type": "object"
}Output_ModelStage
Complete JSON Schema
{
"enum": [
"MODEL_STAGE_UNSPECIFIED",
"UNSTABLE_EXPERIMENTAL",
"EXPERIMENTAL",
"PREVIEW",
"STABLE",
"LEGACY",
"DEPRECATED",
"RETIRED"
],
"type": "string"
}Output_ModelStatus
Complete JSON Schema
Referenced structures: Output_ModelStage
{
"additionalProperties": true,
"properties": {
"message": {
"type": [
"string",
"null"
]
},
"modelStage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModelStage"
},
{
"type": "null"
}
]
},
"retirementTime": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ModelTestResultDto
Complete JSON Schema
Referenced structures: Output_UsageTokensDto
{
"properties": {
"credentialLabel": {
"type": [
"string",
"null"
]
},
"error": {
"type": [
"string",
"null"
]
},
"latencyMs": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"model": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"reply": {
"type": [
"string",
"null"
]
},
"status": {
"description": "The upstream's HTTP status, or 0 when nothing was answered.",
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UsageTokensDto"
},
{
"type": "null"
}
],
"description": "What the upstream reported it spent. Absent when it reported nothing,\nwhich is not the same as zero."
}
},
"required": [
"ok",
"latencyMs",
"status",
"model",
"usage",
"reply",
"credentialLabel",
"error"
],
"type": "object"
}Output_ModelTokenBudgetConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"auto_compact_fallback_buffer_tokens": {
"format": "int64",
"type": "integer"
},
"auto_compact_fallback_prompt": {
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"guidance_message": {
"type": "string"
},
"reminder_message_template": {
"type": "string"
},
"reminder_threshold_tokens": {
"format": "int64",
"type": "integer"
},
"use_history_notes_extension": {
"default": false,
"type": "boolean"
}
},
"required": [
"enabled",
"use_history_notes_extension",
"reminder_threshold_tokens",
"reminder_message_template",
"guidance_message",
"auto_compact_fallback_prompt",
"auto_compact_fallback_buffer_tokens"
],
"type": "object"
}Output_ModelType
Complete JSON Schema
{
"enum": [
"model"
],
"type": "string"
}Output_ModelVisibility
Complete JSON Schema
{
"enum": [
"list",
"hide",
"none"
],
"type": "string"
}Output_Moderation
Complete JSON Schema
{
"enum": [
"auto",
"low"
],
"type": "string"
}Output_ModerationError
Complete JSON Schema
Referenced structures: Output_ModerationErrorType
{
"additionalProperties": true,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ModerationErrorType"
}
},
"required": [
"code",
"message",
"type"
],
"type": "object"
}Output_ModerationErrorType
Complete JSON Schema
{
"enum": [
"error"
],
"type": "string"
}Output_ModerationInputType
Complete JSON Schema
{
"enum": [
"text",
"image"
],
"type": "string"
}Output_ModerationItemType
Complete JSON Schema
{
"enum": [
"moderation_result"
],
"type": "string"
}Output_ModerationResponse
Complete JSON Schema
Referenced structures: Output_ModerationResultOrError
{
"additionalProperties": true,
"properties": {
"input": {
"$ref": "#/components/schemas/Output_ModerationResultOrError"
},
"output": {
"$ref": "#/components/schemas/Output_ModerationResultOrError"
}
},
"required": [
"input",
"output"
],
"type": "object"
}Output_ModerationResult
Complete JSON Schema
Referenced structures: Output_ModerationResultItem, Output_ModerationResultType
{
"additionalProperties": true,
"properties": {
"model": {
"type": "string"
},
"results": {
"items": {
"$ref": "#/components/schemas/Output_ModerationResultItem"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_ModerationResultType"
}
},
"required": [
"model",
"results",
"type"
],
"type": "object"
}Output_ModerationResult2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"categories": {
"additionalProperties": {
"type": [
"boolean",
"null"
]
},
"type": "object"
},
"category_applied_input_types": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"type": "object"
},
"category_scores": {
"additionalProperties": {
"type": "number"
},
"type": "object"
},
"flagged": {
"type": "boolean"
}
},
"required": [
"flagged",
"categories",
"category_scores",
"category_applied_input_types"
],
"type": "object"
}Output_ModerationResultItem
Complete JSON Schema
Referenced structures: Output_ModerationInputType, Output_ModerationItemType
{
"additionalProperties": true,
"properties": {
"categories": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"category_applied_input_types": {
"additionalProperties": {
"items": {
"$ref": "#/components/schemas/Output_ModerationInputType"
},
"type": "array"
},
"type": "object"
},
"category_scores": {
"additionalProperties": {
"format": "double",
"type": "number"
},
"type": "object"
},
"flagged": {
"type": "boolean"
},
"model": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ModerationItemType"
}
},
"required": [
"categories",
"category_applied_input_types",
"category_scores",
"flagged",
"model",
"type"
],
"type": "object"
}Output_ModerationResultOrError
Complete JSON Schema
Referenced structures: Output_ModerationError, Output_ModerationResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ModerationResult"
},
{
"$ref": "#/components/schemas/Output_ModerationError"
}
]
}Output_ModerationResultType
Complete JSON Schema
{
"enum": [
"moderation_results"
],
"type": "string"
}Output_MoveAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"x",
"y"
],
"type": "object"
}Output_MultiAgentCall
Complete JSON Schema
Referenced structures: Output_Action, Output_Agent, Output_MultiAgentCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Output_Action"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_MultiAgentCallType"
}
},
"required": [
"type",
"action",
"arguments",
"call_id"
],
"type": "object"
}Output_MultiAgentCallOutput
Complete JSON Schema
Referenced structures: Output_Action, Output_Agent, Output_MultiAgentCallOutputType, Output_ReplayOutputText
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Output_Action"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"output": {
"items": {
"$ref": "#/components/schemas/Output_ReplayOutputText"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_MultiAgentCallOutputType"
}
},
"required": [
"type",
"action",
"call_id",
"output"
],
"type": "object"
}Output_MultiAgentCallOutputType
Complete JSON Schema
{
"enum": [
"multi_agent_call_output"
],
"type": "string"
}Output_MultiAgentCallType
Complete JSON Schema
{
"enum": [
"multi_agent_call"
],
"type": "string"
}Output_MultiAgentMessages
Complete JSON Schema
Referenced structures: Output_MultiAgentModeMessages, Output_MultiAgentRoleMessages
{
"additionalProperties": true,
"properties": {
"mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MultiAgentModeMessages"
},
{
"type": "null"
}
]
},
"role": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MultiAgentRoleMessages"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_MultiAgentModeMessages
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"explicit": {
"type": [
"string",
"null"
]
},
"hint_text": {
"type": [
"string",
"null"
]
},
"proactive": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_MultiAgentRoleMessages
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"root": {
"type": [
"string",
"null"
]
},
"subagent": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_MultiAgentToolMessages
Complete JSON Schema
Referenced structures: Output_ToolMessage
{
"additionalProperties": true,
"properties": {
"create_channel": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"followup_task": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"get_channels": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"interrupt_agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"list_agents": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"list_threads": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"post": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"read_post": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"read_thread": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"search_posts": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"send_message": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"spawn_agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"subscribe": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"unsubscribe": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
},
"wait_agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_MultiAgentVersion
Complete JSON Schema
{
"enum": [
"disabled",
"v1",
"v2"
],
"type": "string"
}Output_NamespaceCustomTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller, Output_CustomToolFormat
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CustomToolFormat"
},
{
"type": "null"
}
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}Output_NamespaceFunctionTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"async": {
"type": [
"boolean",
"null"
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"output_schema": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"parameters": true,
"strict": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name"
],
"type": "object"
}Output_NamespaceTool
Complete JSON Schema
Referenced structures: Output_NamespaceToolDefinition
{
"additionalProperties": true,
"properties": {
"description": {
"type": "string"
},
"name": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_NamespaceToolDefinition"
},
"type": "array"
}
},
"required": [
"description",
"name",
"tools"
],
"type": "object"
}Output_NamespaceToolDefinition
Complete JSON Schema
Referenced structures: Output_NamespaceCustomTool, Output_NamespaceFunctionTool
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_NamespaceFunctionTool",
"properties": {
"type": {
"const": "function",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_NamespaceCustomTool",
"properties": {
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_NativeDeleteVideoResponseBody
Complete JSON Schema
Referenced structures: Output_NativeVideoDeletedObject
{
"additionalProperties": true,
"properties": {
"deleted": {
"type": "boolean"
},
"id": {
"type": "string"
},
"object": {
"$ref": "#/components/schemas/Output_NativeVideoDeletedObject"
}
},
"required": [
"id",
"deleted",
"object"
],
"type": "object"
}Output_NativeListVideosResponseBody
Complete JSON Schema
Referenced structures: Output_NativeVideo
{
"additionalProperties": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Output_NativeVideo"
},
"type": "array"
},
"has_more": {
"type": [
"boolean",
"null"
]
},
"last_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"data"
],
"type": "object"
}Output_NativeVideo
Complete JSON Schema
Referenced structures: Output_NativeVideoError, Output_NativeVideoObject, Output_NativeVideoSize, Output_NativeVideoStatus
{
"additionalProperties": true,
"properties": {
"completed_at": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"created_at": {
"format": "int64",
"type": "integer"
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_NativeVideoError"
},
{
"type": "null"
}
]
},
"expires_at": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"type": "string"
},
"model": {
"type": "string"
},
"object": {
"$ref": "#/components/schemas/Output_NativeVideoObject"
},
"progress": {
"format": "int64",
"type": "integer"
},
"prompt": {
"type": [
"string",
"null"
]
},
"remixed_from_video_id": {
"type": [
"string",
"null"
]
},
"seconds": {
"type": "string"
},
"size": {
"$ref": "#/components/schemas/Output_NativeVideoSize"
},
"status": {
"$ref": "#/components/schemas/Output_NativeVideoStatus"
}
},
"required": [
"id",
"created_at",
"model",
"object",
"progress",
"seconds",
"size",
"status"
],
"type": "object"
}Output_NativeVideoDeletedObject
Complete JSON Schema
{
"enum": [
"video.deleted"
],
"type": "string"
}Output_NativeVideoError
Complete JSON Schema
Referenced structures: Output_NativeVideoMisalignment
{
"additionalProperties": true,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"misalignment": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_NativeVideoMisalignment"
},
{
"type": "null"
}
]
}
},
"required": [
"code",
"message"
],
"type": "object"
}Output_NativeVideoMisalignment
Complete JSON Schema
Referenced structures: Output_NativeVideoSteer
{
"additionalProperties": true,
"description": "video_create_error.py in the pinned SDK includes structured safety context.",
"properties": {
"detailed_explanation": {
"type": [
"string",
"null"
]
},
"error_type": {
"type": [
"string",
"null"
]
},
"steer": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_NativeVideoSteer"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_NativeVideoObject
Complete JSON Schema
{
"enum": [
"video"
],
"type": "string"
}Output_NativeVideoSize
Complete JSON Schema
{
"enum": [
"720x1280",
"1280x720",
"1024x1792",
"1792x1024"
],
"type": "string"
}Output_NativeVideoStatus
Complete JSON Schema
{
"enum": [
"queued",
"in_progress",
"completed",
"failed"
],
"type": "string"
}Output_NativeVideoSteer
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
}Output_NetworkAllowlist
Complete JSON Schema
Referenced structures: Output_DomainSecret, Output_NetworkAllowlistType
{
"additionalProperties": true,
"properties": {
"allowed_domains": {
"items": {
"type": "string"
},
"type": "array"
},
"domain_secrets": {
"items": {
"$ref": "#/components/schemas/Output_DomainSecret"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_NetworkAllowlistType"
}
},
"required": [
"allowed_domains",
"type"
],
"type": "object"
}Output_NetworkAllowlistType
Complete JSON Schema
{
"enum": [
"allowlist"
],
"type": "string"
}Output_NetworkDisabled
Complete JSON Schema
Referenced structures: Output_NetworkDisabledType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_NetworkDisabledType"
}
},
"required": [
"type"
],
"type": "object"
}Output_NetworkDisabledType
Complete JSON Schema
{
"enum": [
"disabled"
],
"type": "string"
}Output_NoiseReductionType
Complete JSON Schema
{
"description": "Source: `openai/types/realtime/noise_reduction_type.py`, `NoiseReductionType`.",
"enum": [
"near_field",
"far_field"
],
"type": "string"
}Output_OAuthClientDto
Complete JSON Schema
{
"properties": {
"deletedAtMs": {
"description": "Set by `retire`, cleared when the same id is registered again. A\nretired client is kept so session history still resolves; a new\nregistration does not un-revoke its grants.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"description": "The public `client_id`, chosen at registration and immutable after it.",
"type": "string"
},
"name": {
"type": "string"
},
"redirectUris": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"name",
"redirectUris",
"enabled",
"deletedAtMs"
],
"type": "object"
}Output_OAuthErrorBody
Complete JSON Schema
{
"description": "RFC 6749 §5.2's error body, which RFC 7009 and RFC 8628 reuse.",
"properties": {
"error": {
"type": "string"
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
],
"type": "object"
}Output_OpenAiEmbedding
Complete JSON Schema
Referenced structures: Output_EmbeddingObject, Output_EmbeddingVector
{
"additionalProperties": true,
"properties": {
"embedding": {
"$ref": "#/components/schemas/Output_EmbeddingVector"
},
"index": {
"format": "int64",
"type": "integer"
},
"object": {
"$ref": "#/components/schemas/Output_EmbeddingObject"
}
},
"required": [
"embedding",
"index",
"object"
],
"type": "object"
}Output_OperationEndpointDto
Complete JSON Schema
{
"description": "A complete method URL for one `(operation, dialect, transport)` of one\nprovider. It replaces the URL the channel would build, not just its host.",
"properties": {
"dialect": {
"description": "A `gproxy_protocol::Dialect` id, e.g. `openai`.",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"operation": {
"type": "string"
},
"providerId": {
"type": "string"
},
"transport": {
"description": "`http` or `websocket`.",
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"id",
"providerId",
"operation",
"dialect",
"transport",
"url",
"enabled"
],
"type": "object"
}Output_OperationRoutingDto
Complete JSON Schema
Referenced structures: Output_RoutingMappingDto, Output_RoutingTargetDto
{
"properties": {
"custom": {
"type": "boolean"
},
"defaultMapping": {
"$ref": "#/components/schemas/Output_RoutingMappingDto"
},
"dialect": {
"type": "string"
},
"localAvailable": {
"type": "boolean"
},
"mapping": {
"$ref": "#/components/schemas/Output_RoutingMappingDto"
},
"operation": {
"type": "string"
},
"targets": {
"items": {
"$ref": "#/components/schemas/Output_RoutingTargetDto"
},
"type": "array"
}
},
"required": [
"operation",
"dialect",
"defaultMapping",
"mapping",
"custom",
"localAvailable",
"targets"
],
"type": "object"
}Output_OperationRuleDto
Complete JSON Schema
{
"properties": {
"action": {
"type": "string"
},
"id": {
"type": "string"
},
"operation": {
"description": "A `gproxy_protocol::Operation` id, e.g. `generate_content`.",
"type": "string"
},
"providerId": {
"type": "string"
},
"target": {
"description": "Action-specific target, e.g. the destination `OperationKey`."
}
},
"required": [
"id",
"providerId",
"operation",
"action",
"target"
],
"type": "object"
}Output_OrganizationDto
Complete JSON Schema
{
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"oauthClientAllowlist": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"required": [
"id",
"name",
"oauthClientAllowlist",
"createdAtMs"
],
"type": "object"
}Output_OrganizationMemberDto
Complete JSON Schema
{
"properties": {
"organizationId": {
"type": "string"
},
"role": {
"description": "`member` or `admin`. Scoped to this organization; it is not the user's\ninstance role.",
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"organizationId",
"userId",
"role"
],
"type": "object"
}Output_Outcome
Complete JSON Schema
{
"enum": [
"OUTCOME_UNSPECIFIED",
"OUTCOME_OK",
"OUTCOME_FAILED",
"OUTCOME_DEADLINE_EXCEEDED"
],
"type": "string"
}Output_OutputAnnotation
Complete JSON Schema
Referenced structures: Output_ContainerFileCitation, Output_FileCitation, Output_FilePath, Output_UrlCitation
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileCitation"
},
{
"$ref": "#/components/schemas/Output_UrlCitation"
},
{
"$ref": "#/components/schemas/Output_ContainerFileCitation"
},
{
"$ref": "#/components/schemas/Output_FilePath"
}
]
}Output_OutputContent
Complete JSON Schema
Referenced structures: Output_ResponseOutputRefusal, Output_ResponseOutputText
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseOutputText"
},
{
"$ref": "#/components/schemas/Output_ResponseOutputRefusal"
}
]
}Output_OutputContentPart
Complete JSON Schema
Referenced structures: Output_ReasoningText, Output_ResponseOutputRefusal, Output_ResponseOutputText
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseOutputText"
},
{
"$ref": "#/components/schemas/Output_ResponseOutputRefusal"
},
{
"$ref": "#/components/schemas/Output_ReasoningText"
}
]
}Output_OutputImageBackground
Complete JSON Schema
{
"enum": [
"transparent",
"opaque"
],
"type": "string"
}Output_OutputImageQuality
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"xhigh",
"max"
],
"type": "string"
}Output_OutputImageSize
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"1024x1024",
"1024x1536",
"1536x1024"
],
"type": "string"
},
{
"type": "string"
}
]
}Output_OutputItemEvent
Complete JSON Schema
Referenced structures: Output_Agent, Output_ResponseOutputItem
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/Output_ResponseOutputItem"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"output_index",
"item"
],
"type": "object"
}Output_OutputLogprob
Complete JSON Schema
Referenced structures: Output_TopLogprob
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"logprob": {
"type": "number"
},
"token": {
"type": "string"
},
"top_logprobs": {
"items": {
"$ref": "#/components/schemas/Output_TopLogprob"
},
"type": "array"
}
},
"required": [
"token",
"bytes",
"logprob",
"top_logprobs"
],
"type": "object"
}Output_OutputMessageRole
Complete JSON Schema
{
"enum": [
"assistant"
],
"type": "string"
}Output_OutputMessageStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete"
],
"type": "string"
}Output_OutputTextAnnotationAdded
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"annotation": true,
"annotation_index": {
"format": "int64",
"type": "integer"
},
"content_index": {
"format": "int64",
"type": "integer"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"annotation_index",
"annotation"
],
"type": "object"
}Output_OutputTextDelta
Complete JSON Schema
Referenced structures: Output_Agent, Output_StreamLogprob
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content_index": {
"format": "int64",
"type": "integer"
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_StreamLogprob"
},
"type": "array"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"delta",
"logprobs"
],
"type": "object"
}Output_OutputTextDone
Complete JSON Schema
Referenced structures: Output_Agent, Output_StreamLogprob
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content_index": {
"format": "int64",
"type": "integer"
},
"item_id": {
"type": "string"
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_StreamLogprob"
},
"type": "array"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"text": {
"type": "string"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"text",
"logprobs"
],
"type": "object"
}Output_OutputTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"thinking_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"thinking_tokens"
],
"type": "object"
}Output_Page
Complete JSON Schema
Referenced structures: Output_UserDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_UserDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page10
Complete JSON Schema
Referenced structures: Output_UserSessionDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_UserSessionDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page11
Complete JSON Schema
Referenced structures: Output_AuditEventDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_AuditEventDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page12
Complete JSON Schema
Referenced structures: Output_ProviderDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_ProviderDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page13
Complete JSON Schema
Referenced structures: Output_CredentialDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_CredentialDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page14
Complete JSON Schema
Referenced structures: Output_ModelDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_ModelDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page15
Complete JSON Schema
Referenced structures: Output_ProviderModelDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_ProviderModelDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page16
Complete JSON Schema
Referenced structures: Output_RouteDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_RouteDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page17
Complete JSON Schema
Referenced structures: Output_RouteMemberDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_RouteMemberDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page18
Complete JSON Schema
Referenced structures: Output_ConnectionProfileDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_ConnectionProfileDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page19
Complete JSON Schema
Referenced structures: Output_RuleSetDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_RuleSetDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page2
Complete JSON Schema
Referenced structures: Output_ApiKeyDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_ApiKeyDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page20
Complete JSON Schema
Referenced structures: Output_RewriteRuleDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_RewriteRuleDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page21
Complete JSON Schema
Referenced structures: Output_ProviderRuleSetDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_ProviderRuleSetDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page22
Complete JSON Schema
Referenced structures: Output_OperationRuleDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_OperationRuleDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page23
Complete JSON Schema
Referenced structures: Output_OperationEndpointDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_OperationEndpointDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page24
Complete JSON Schema
Referenced structures: Output_QuotaDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_QuotaDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page25
Complete JSON Schema
Referenced structures: Output_PriceRuleDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_PriceRuleDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page26
Complete JSON Schema
Referenced structures: Output_PriceRateDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_PriceRateDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page27
Complete JSON Schema
Referenced structures: Output_PriceTierDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_PriceTierDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page28
Complete JSON Schema
Referenced structures: Output_QuotaObservationDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_QuotaObservationDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page29
Complete JSON Schema
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page3
Complete JSON Schema
Referenced structures: Output_OrganizationDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_OrganizationDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page4
Complete JSON Schema
Referenced structures: Output_TeamDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_TeamDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page5
Complete JSON Schema
Referenced structures: Output_PermissionDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_PermissionDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page6
Complete JSON Schema
Referenced structures: Output_RateLimitDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_RateLimitDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page7
Complete JSON Schema
Referenced structures: Output_OAuthClientDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_OAuthClientDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page8
Complete JSON Schema
Referenced structures: Output_OrganizationMemberDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_OrganizationMemberDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Page9
Complete JSON Schema
Referenced structures: Output_TeamMemberDto
{
"description": "One page of results. `total` counts every row the filters match, not the\npage, so a console can render a pager without a second request.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_TeamMemberDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"items",
"total",
"offset",
"limit"
],
"type": "object"
}Output_Part
Complete JSON Schema
Referenced structures: Output_AudioTranscription, Output_Blob, Output_CodeExecutionResult2, Output_ExecutableCode, Output_FileData, Output_FunctionCall2, Output_FunctionResponse, Output_MediaProcessing, Output_MediaResolution, Output_SpeechMetadata, Output_ToolCall, Output_ToolResponse, Output_VideoMetadata
{
"additionalProperties": true,
"properties": {
"audioTranscription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AudioTranscription"
},
{
"type": "null"
}
]
},
"codeExecutionResult": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CodeExecutionResult2"
},
{
"type": "null"
}
]
},
"executableCode": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ExecutableCode"
},
{
"type": "null"
}
]
},
"fileData": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileData"
},
{
"type": "null"
}
]
},
"functionCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FunctionCall2"
},
{
"type": "null"
}
]
},
"functionResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FunctionResponse"
},
{
"type": "null"
}
]
},
"inlineData": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Blob"
},
{
"type": "null"
}
]
},
"mediaProcessing": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MediaProcessing"
},
{
"type": "null"
}
]
},
"mediaResolution": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MediaResolution"
},
{
"type": "null"
}
]
},
"partMetadata": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"speechMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SpeechMetadata"
},
{
"type": "null"
}
]
},
"text": {
"type": [
"string",
"null"
]
},
"thought": {
"type": [
"boolean",
"null"
]
},
"thoughtSignature": {
"type": [
"string",
"null"
]
},
"toolCall": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolCall"
},
{
"type": "null"
}
]
},
"toolResponse": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolResponse"
},
{
"type": "null"
}
]
},
"videoMetadata": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VideoMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_PdfBase64Source
Complete JSON Schema
Referenced structures: Output_PdfMediaType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"media_type": {
"$ref": "#/components/schemas/Output_PdfMediaType"
}
},
"required": [
"data",
"media_type"
],
"type": "object"
}Output_PdfMediaType
Complete JSON Schema
{
"enum": [
"application/pdf"
],
"type": "string"
}Output_PendingSafetyCheck
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"message": {
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
}Output_PermissionDto
Complete JSON Schema
{
"properties": {
"action": {
"description": "`allow` or `deny`.",
"type": "string"
},
"apiKeyId": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"modelPattern": {
"description": "A glob: `*` and `?`, anchored, case-sensitive. `*` matches a request\nthat names no model at all.",
"type": "string"
},
"operation": {
"description": "None means every operation.",
"type": [
"string",
"null"
]
},
"priority": {
"description": "Higher wins; ties fall back to id order.",
"format": "int32",
"type": "integer"
},
"providerId": {
"description": "None means every provider.",
"type": [
"string",
"null"
]
},
"userId": {
"description": "Exactly one of these two is set. A rule with neither is a grant to\nnobody; a rule with both is an intersection the snapshot still honours\nbut this family refuses to write, because nobody who wrote one meant\n\"the key *and* the user\".",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"userId",
"apiKeyId",
"providerId",
"modelPattern",
"operation",
"action",
"priority"
],
"type": "object"
}Output_PermissionMessages
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"danger_full_access": {
"type": [
"string",
"null"
]
},
"read_only": {
"type": [
"string",
"null"
]
},
"workspace_write": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_PingEvent
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_PlaceAnswerSources
Complete JSON Schema
Referenced structures: Output_ReviewSnippet
{
"additionalProperties": true,
"properties": {
"reviewSnippets": {
"items": {
"$ref": "#/components/schemas/Output_ReviewSnippet"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_PlainTextSource
Complete JSON Schema
Referenced structures: Output_TextMediaType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"media_type": {
"$ref": "#/components/schemas/Output_TextMediaType"
}
},
"required": [
"data",
"media_type"
],
"type": "object"
}Output_PortalContextDto
Complete JSON Schema
Referenced structures: Output_PortalFeaturesDto, Output_PortalOrganizationDto, Output_PortalTeamDto, Output_PortalUserDto
{
"description": "Everything a portal needs to render its shell, in one call: who you are,\nwhich scopes you belong to, what you are subscribed to, and which parts of\nthe portal this instance offers you.",
"properties": {
"features": {
"$ref": "#/components/schemas/Output_PortalFeaturesDto"
},
"organizations": {
"description": "Direct organization memberships. A team joined without its parent is\n*not* listed here; the team is, with its `organizationId`.",
"items": {
"$ref": "#/components/schemas/Output_PortalOrganizationDto"
},
"type": "array"
},
"teams": {
"items": {
"$ref": "#/components/schemas/Output_PortalTeamDto"
},
"type": "array"
},
"user": {
"$ref": "#/components/schemas/Output_PortalUserDto"
}
},
"required": [
"user",
"organizations",
"teams",
"features"
],
"type": "object"
}Output_PortalFeaturesDto
Complete JSON Schema
{
"description": "What this instance lets this caller do, so a portal can hide a tab rather\nthan render one that answers 403.\n\nEvery flag is a fact about configuration or about the caller's role — never\nabout data — so computing it costs nothing and leaks nothing.",
"properties": {
"canChangePassword": {
"description": "Same rule, same reason: a third-party program does not get to change\nthe account password it was lent.",
"type": "boolean"
},
"canCreateKeys": {
"description": "Whether the key family's writing half is open. False for an OAuth-grant\ncaller: a token the user handed to somebody else's program must not be\nable to mint a fresh long-lived credential out of that trust.",
"type": "boolean"
},
"canSeeConsole": {
"description": "Whether to offer a link into the operator console: it has to be built\ninto this instance *and* the caller has to be an instance administrator.",
"type": "boolean"
},
"canSeeLogs": {
"description": "`settings.portal_recent_requests_enabled`. Off means\n[`Portal::recent_requests`](crate::operations::Portal::recent_requests)\nanswers with nothing.",
"type": "boolean"
}
},
"required": [
"canCreateKeys",
"canChangePassword",
"canSeeLogs",
"canSeeConsole"
],
"type": "object"
}Output_PortalKeyCreated
Complete JSON Schema
{
"description": "A minted or rotated key. `token` is the only time the plaintext travels,\napart from an explicit reveal of a key that retained one.",
"properties": {
"enabled": {
"type": "boolean"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"hasSecret": {
"description": "Whether the instance retained a sealed copy, i.e. whether `reveal` can\nanswer for this key.",
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"organizationId": {
"type": [
"string",
"null"
]
},
"prefix": {
"description": "The first characters of the key body, for telling two keys apart.",
"type": "string"
},
"teamId": {
"type": [
"string",
"null"
]
},
"token": {
"type": "string"
}
},
"required": [
"id",
"name",
"prefix",
"organizationId",
"teamId",
"expiresAtMs",
"enabled",
"hasSecret",
"token"
],
"type": "object"
}Output_PortalKeyDto
Complete JSON Schema
{
"description": "One of the caller's own gateway keys.\n\nNo `userId`: it is always the caller. No `kind`: the portal only ever shows\n`user` keys, because an `oauth` key belongs to a grant and is managed by\nrevoking that grant.",
"properties": {
"enabled": {
"type": "boolean"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"hasSecret": {
"description": "Whether the instance retained a sealed copy, i.e. whether `reveal` can\nanswer for this key.",
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"organizationId": {
"type": [
"string",
"null"
]
},
"prefix": {
"description": "The first characters of the key body, for telling two keys apart.",
"type": "string"
},
"teamId": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"name",
"prefix",
"organizationId",
"teamId",
"expiresAtMs",
"enabled",
"hasSecret"
],
"type": "object"
}Output_PortalKeySecretDto
Complete JSON Schema
{
"description": "The answer to a reveal. Separate from [`PortalKeyDto`] so a plaintext can\nnever ride along with an ordinary read.",
"properties": {
"id": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"id",
"token"
],
"type": "object"
}Output_PortalModelDto
Complete JSON Schema
{
"description": "One addressable model name, and whether this caller may call it.\n\n`providerCount` and `channelIds` describe the providers that back the name\non this instance, not the ones this caller may reach — a count and a\nchannel id are instance configuration, and knowing that `codex/gpt-5` is\nserved by two providers tells a user nothing about another tenant.\n`permitted` is the caller's own answer.",
"properties": {
"channelIds": {
"description": "The channels behind the name, sorted and deduplicated.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Either an exposed model name or a `providerName/model` form.",
"type": "string"
},
"permitted": {
"description": "Whether at least one of those providers is one the caller's permission\nrules allow for this name.",
"type": "boolean"
},
"providerCount": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"name",
"providerCount",
"channelIds",
"permitted"
],
"type": "object"
}Output_PortalOAuthSessionDto
Complete JSON Schema
{
"description": "One live authorization the caller granted to a third-party client.",
"properties": {
"clientId": {
"type": "string"
},
"clientName": {
"description": "The client's registered display name, or None when the registration is\ngone.",
"type": [
"string",
"null"
]
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"lastRefreshedAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"loggedInAtMs": {
"description": "The first successful token exchange. None means consent was given but\nthe client never completed the login.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"refreshCount": {
"format": "int64",
"type": "integer"
},
"refreshExpiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"scopes": {
"description": "The scopes this grant carries, as granted.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"clientId",
"clientName",
"scopes",
"createdAtMs",
"loggedInAtMs",
"lastRefreshedAtMs",
"refreshCount",
"refreshExpiresAtMs"
],
"type": "object"
}Output_PortalOrganizationDto
Complete JSON Schema
{
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"description": "`member` or `admin`, scoped to this organization.",
"type": "string"
}
},
"required": [
"id",
"name",
"role"
],
"type": "object"
}Output_PortalQuotaWindowDto
Complete JSON Schema
{
"description": "One budget window of the caller's own chain.\n\nThe owner is reported because a user has to be able to tell \"I am out of my\nown allowance\" from \"my team is out of its allowance\", which are two very\ndifferent things to do something about. Every owner here is one the caller\nis themselves part of: the chain is built from their own key binding.",
"properties": {
"limit": {
"type": "string"
},
"modelPattern": {
"description": "The glob this budget covers, absent when it covers everything.",
"type": [
"string",
"null"
]
},
"ownerId": {
"type": "string"
},
"ownerKind": {
"description": "`api_key`, `user`, `team` or `org`.",
"type": "string"
},
"period": {
"description": "`5h`, `1d`, `7d`, `1m`, `total`, …",
"type": "string"
},
"resetsAtMs": {
"description": "None for a permanent (`total`) window.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"startsAtMs": {
"format": "int64",
"type": "integer"
},
"unit": {
"description": "`USD` for a cost budget.",
"type": "string"
},
"used": {
"type": "string"
},
"usedPercent": {
"description": "On the 0..100 scale, to two decimals. None when the limit is zero,\nwhich is a switched-off subject rather than a ratio.",
"type": [
"string",
"null"
]
},
"windowKey": {
"description": "The budget's stable key within its owner, e.g. `primary`.",
"type": "string"
}
},
"required": [
"ownerKind",
"ownerId",
"windowKey",
"period",
"modelPattern",
"unit",
"used",
"limit",
"usedPercent",
"startsAtMs",
"resetsAtMs"
],
"type": "object"
}Output_PortalRequestDto
Complete JSON Schema
{
"description": "One of the caller's own recent requests, reduced.\n\nWhat is missing is the point: no bodies, no headers, no URL, no client\naddress, no credential id, and no provider id — only the provider's display\nname, and only when it still exists. See the module note on\n[`Portal::recent_requests`](crate::operations::Portal::recent_requests).",
"properties": {
"apiKeyId": {
"description": "The caller's own key that made the request, when one did.",
"type": [
"string",
"null"
]
},
"durationMs": {
"description": "End minus start, when the request has ended.",
"format": "int64",
"type": [
"integer",
"null"
]
},
"endedAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"model": {
"description": "The name the client asked for.",
"type": [
"string",
"null"
]
},
"operation": {
"type": [
"string",
"null"
]
},
"provider": {
"description": "The upstream's display name. Never its id, never its credential.",
"type": [
"string",
"null"
]
},
"requestId": {
"type": "string"
},
"responseStatus": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"startedAtMs": {
"format": "int64",
"type": "integer"
},
"state": {
"description": "`in_progress`, `completed`, `failed` or `cancelled`. Capture\ncompleteness, not the upstream's verdict.",
"type": "string"
}
},
"required": [
"requestId",
"apiKeyId",
"model",
"operation",
"provider",
"responseStatus",
"state",
"startedAtMs",
"endedAtMs",
"durationMs"
],
"type": "object"
}Output_PortalTeamDto
Complete JSON Schema
{
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"organizationId": {
"type": "string"
},
"role": {
"description": "`member` or `admin`, scoped to this team. An organization admin is not\nautomatically a team admin.",
"type": "string"
}
},
"required": [
"id",
"name",
"organizationId",
"role"
],
"type": "object"
}Output_PortalUsageDto
Complete JSON Schema
Referenced structures: Output_UsageGroupDto, Output_UsageSummaryDto, Output_UsageTrendPointDto
{
"description": "The caller's own usage over the requested range.",
"properties": {
"fromMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"groups": {
"description": "Empty unless `groupBy` was given.",
"items": {
"$ref": "#/components/schemas/Output_UsageGroupDto"
},
"type": "array"
},
"summary": {
"$ref": "#/components/schemas/Output_UsageSummaryDto"
},
"toMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"trend": {
"description": "Empty unless `bucketMs` was given.",
"items": {
"$ref": "#/components/schemas/Output_UsageTrendPointDto"
},
"type": "array"
}
},
"required": [
"fromMs",
"toMs",
"summary",
"groups",
"trend"
],
"type": "object"
}Output_PortalUserDto
Complete JSON Schema
{
"properties": {
"hasPassword": {
"description": "Whether a password is set. An account without one signs in through\nOAuth only, and its password change takes no `current`.",
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"description": "The instance-wide role, `admin` or `user`. Organization and team roles\nare memberships and are listed with their scope.",
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"hasPassword"
],
"type": "object"
}Output_PreviewUserLocation
Complete JSON Schema
Referenced structures: Output_UserLocationType
{
"additionalProperties": true,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"region": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_UserLocationType"
}
},
"required": [
"type"
],
"type": "object"
}Output_PriceRateDto
Complete JSON Schema
{
"description": "One billable quantity's price. `value` buys `unit_quantity` units, so a\nper-million token price is `unit_quantity = 1000000`.",
"properties": {
"conditions": {
"description": "None is the fallback rate; otherwise a nonempty object of dimensions."
},
"id": {
"type": "string"
},
"metric": {
"description": "A `gproxy_store::entity::pricing::metric` key, or a custom one.",
"type": "string"
},
"priceRuleId": {
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"unit": {
"description": "`token`, `count`, `second` or `character`.",
"type": "string"
},
"unitQuantity": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"id",
"priceRuleId",
"metric",
"unit",
"unitQuantity",
"value",
"conditions",
"priority"
],
"type": "object"
}Output_PriceRuleDto
Complete JSON Schema
{
"properties": {
"currency": {
"description": "ISO 4217, three letters.",
"type": "string"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"modelPattern": {
"description": "A `*`/`?` glob over the upstream model name.",
"type": "string"
},
"operation": {
"description": "None covers every operation of the matched model.",
"type": [
"string",
"null"
]
},
"priority": {
"format": "int32",
"type": "integer"
},
"providerId": {
"description": "None prices every provider; a provider rule wins over a global one.",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"providerId",
"modelPattern",
"operation",
"priority",
"currency",
"enabled"
],
"type": "object"
}Output_PriceTierDto
Complete JSON Schema
Referenced structures: Output_CacheCreationPriceDto
{
"description": "A context or service-tier override inside one rule. Every per-million\nprice is optional: None inherits, zero is explicitly free.",
"properties": {
"audioInputPerMillion": {
"type": [
"string",
"null"
]
},
"audioOutputPerMillion": {
"type": [
"string",
"null"
]
},
"cacheCreationPerMillion": {
"default": [],
"items": {
"$ref": "#/components/schemas/Output_CacheCreationPriceDto"
},
"type": "array"
},
"cacheReadPerMillion": {
"type": [
"string",
"null"
]
},
"cachedAudioInputPerMillion": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"imageInputPerMillion": {
"type": [
"string",
"null"
]
},
"imageOutputPerMillion": {
"type": [
"string",
"null"
]
},
"inputPerMillion": {
"type": [
"string",
"null"
]
},
"minPromptTokens": {
"format": "int64",
"type": "integer"
},
"multiplier": {
"type": [
"string",
"null"
]
},
"outputPerMillion": {
"type": [
"string",
"null"
]
},
"priceRuleId": {
"type": "string"
},
"priority": {
"format": "int32",
"type": "integer"
},
"reasoningPerMillion": {
"type": [
"string",
"null"
]
},
"serviceTier": {
"description": "None is a context tier; otherwise `standard`, `priority`, `flex`, … .",
"type": [
"string",
"null"
]
},
"videoInputPerMillion": {
"type": [
"string",
"null"
]
},
"videoPerMillion": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"priceRuleId",
"serviceTier",
"minPromptTokens",
"priority",
"multiplier",
"inputPerMillion",
"outputPerMillion",
"cacheReadPerMillion",
"cacheCreationPerMillion",
"reasoningPerMillion",
"imageInputPerMillion",
"imageOutputPerMillion",
"audioInputPerMillion",
"cachedAudioInputPerMillion",
"audioOutputPerMillion",
"videoInputPerMillion",
"videoPerMillion"
],
"type": "object"
}Output_Program
Complete JSON Schema
Referenced structures: Output_Agent, Output_ProgramType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"code": {
"type": "string"
},
"fingerprint": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ProgramType"
}
},
"required": [
"type",
"id",
"call_id",
"code",
"fingerprint"
],
"type": "object"
}Output_ProgramCaller
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"caller_id": {
"type": "string"
}
},
"required": [
"caller_id"
],
"type": "object"
}Output_ProgramOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ProgramOutputStatus, Output_ProgramOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"result": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Output_ProgramOutputStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ProgramOutputType"
}
},
"required": [
"type",
"id",
"call_id",
"result",
"status"
],
"type": "object"
}Output_ProgramOutputStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete"
],
"type": "string"
}Output_ProgramOutputType
Complete JSON Schema
{
"enum": [
"program_output"
],
"type": "string"
}Output_ProgramType
Complete JSON Schema
{
"enum": [
"program"
],
"type": "string"
}Output_PromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Output_PromptCacheBreakpointTtl, Output_PromptCacheMode
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Output_PromptCacheMode"
},
"ttl": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheBreakpointTtl"
},
{
"type": "null"
}
],
"description": "Minimum lifetime of this breakpoint; omitted inherits the request TTL.\nOpenAI OpenAPI: PromptCacheBreakpointParam (2026-10-21)."
}
},
"required": [
"mode"
],
"type": "object"
}Output_PromptCacheBreakpointTtl
Complete JSON Schema
{
"description": "Explicit cache-breakpoint lifetimes from OpenAI's PromptCacheBreakpointParam.\nSeparate from the request-wide PromptCacheTTLEnum and legacy retention policy.",
"enum": [
"30m",
"12h"
],
"type": "string"
}Output_PromptCacheDiagnostics
Complete JSON Schema
Referenced structures: Output_CacheMiss, Output_DiagnosticOutcome
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_CacheMiss",
"properties": {
"type": {
"const": "cache_miss",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_DiagnosticOutcome",
"properties": {
"type": {
"const": "cache_hit",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_DiagnosticOutcome",
"properties": {
"type": {
"const": "comparison_response_not_found",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_DiagnosticOutcome",
"properties": {
"type": {
"const": "unavailable",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_PromptCacheMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Output_PromptCacheRetention
Complete JSON Schema
{
"enum": [
"in_memory",
"24h"
],
"type": "string"
}Output_PromptCacheTtl
Complete JSON Schema
{
"description": "Request-wide lifetimes from upstream_docs/openai/docs/Prompt caching.md.\nThe 2026-10-20 release predates the reference's request-level TTL enum update.",
"enum": [
"30m",
"12h"
],
"type": "string"
}Output_PromptCachingMode
Complete JSON Schema
{
"enum": [
"implicit",
"explicit"
],
"type": "string"
}Output_PromptFeedback
Complete JSON Schema
Referenced structures: Output_BlockReason, Output_SafetyRating
{
"additionalProperties": true,
"properties": {
"blockReason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_BlockReason"
},
{
"type": "null"
}
]
},
"safetyRatings": {
"items": {
"$ref": "#/components/schemas/Output_SafetyRating"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_PromptTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cache_write_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cached_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"image_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_PromptVariableValue
Complete JSON Schema
Referenced structures: Output_ResponseInputFile, Output_ResponseInputImage, Output_ResponseInputText
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Output_ResponseInputText"
},
{
"$ref": "#/components/schemas/Output_ResponseInputImage"
},
{
"$ref": "#/components/schemas/Output_ResponseInputFile"
}
],
"description": "Prompt variables are a closed union, not arbitrary JSON (source line 4419)."
}Output_ProviderDto
Complete JSON Schema
{
"properties": {
"baseUrl": {
"type": [
"string",
"null"
]
},
"channel": {
"description": "The channel implementation this provider speaks through; must be one\nof `Gproxy::channels()`.",
"type": "string"
},
"config": {
"description": "Channel-specific configuration; always a JSON object."
},
"connectionProfileId": {
"type": [
"string",
"null"
]
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"displayName": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"description": "Invocation URL prefix.",
"type": "string"
},
"proxy": {
"default": null
}
},
"required": [
"id",
"name",
"displayName",
"channel",
"baseUrl",
"connectionProfileId",
"proxy",
"config",
"enabled",
"createdAtMs"
],
"type": "object"
}Output_ProviderModelDto
Complete JSON Schema
Referenced structures: Output_PriceRuleDto
{
"properties": {
"enabled": {
"type": "boolean"
},
"hasPrice": {
"description": "A saved enabled provider or global price rule matches; populated by reads.",
"type": [
"boolean",
"null"
]
},
"id": {
"type": "string"
},
"metadata": true,
"modelId": {
"type": [
"string",
"null"
]
},
"priceRules": {
"description": "Saved, enabled rules matching this model, in billing precedence order.",
"items": {
"$ref": "#/components/schemas/Output_PriceRuleDto"
},
"type": [
"array",
"null"
]
},
"providerId": {
"type": "string"
},
"upstreamName": {
"description": "The name this provider's upstream answers to, not the public one.",
"type": "string"
}
},
"required": [
"id",
"providerId",
"upstreamName",
"modelId",
"metadata",
"enabled"
],
"type": "object"
}Output_ProviderRuleSetDto
Complete JSON Schema
{
"description": "A rule set attached to a provider, in attachment order.",
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"providerId": {
"type": "string"
},
"ruleSetId": {
"type": "string"
},
"sortOrder": {
"format": "int64",
"type": "integer"
},
"updatedAtMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"providerId",
"ruleSetId",
"sortOrder",
"enabled",
"createdAtMs",
"updatedAtMs"
],
"type": "object"
}Output_QuotaAllowanceDto
Complete JSON Schema
{
"description": "None means the upstream did not report the field, never zero.",
"properties": {
"limit": {
"type": [
"string",
"null"
]
},
"periodEndMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"periodStartMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"remaining": {
"type": [
"string",
"null"
]
},
"resetBehavior": {
"description": "`periodic`, `recovering`, `expiring` or `unknown`.",
"type": "string"
},
"unit": {
"type": [
"string",
"null"
]
},
"unlimited": {
"type": [
"boolean",
"null"
]
},
"used": {
"type": [
"string",
"null"
]
},
"usedPercent": {
"description": "On the 0..100 scale.",
"type": [
"string",
"null"
]
}
},
"required": [
"used",
"limit",
"remaining",
"usedPercent",
"unlimited",
"unit",
"periodStartMs",
"periodEndMs",
"resetBehavior"
],
"type": "object"
}Output_QuotaBalanceDto
Complete JSON Schema
{
"properties": {
"remaining": {
"type": [
"string",
"null"
]
},
"unit": {
"type": [
"string",
"null"
]
}
},
"required": [
"remaining",
"unit"
],
"type": "object"
}Output_QuotaBreakdownRowDto
Complete JSON Schema
{
"properties": {
"key": {
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"percent": {
"type": "string"
}
},
"required": [
"key",
"label",
"percent"
],
"type": "object"
}Output_QuotaDto
Complete JSON Schema
{
"description": "One configured budget or operator limit. `owner_kind` is a free string:\n`user`, `api_key`, `team`, `org` and `pool` are caller budgets the host\nnames per request, while `credential` and `provider` are operator limits on\nupstream accounts. Both live in one table because both are windows over a\nmetric.",
"properties": {
"anchorAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"limitValue": {
"type": "string"
},
"metric": {
"description": "`cost` for a budget; `requests` or `cost` for a limit.",
"type": "string"
},
"modelPattern": {
"description": "A `*`/`?` glob over the upstream model name; absent covers everything.",
"type": [
"string",
"null"
]
},
"ownerId": {
"type": "string"
},
"ownerKind": {
"type": "string"
},
"period": {
"description": "`5h`, `1d`, `7d`, `1m`, `total`, or anything with `period_seconds`.",
"type": "string"
},
"periodSeconds": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"unit": {
"description": "`USD` for cost, `count` for requests.",
"type": "string"
},
"windowKey": {
"description": "Stable key within the owner, e.g. `primary`.",
"type": "string"
}
},
"required": [
"id",
"ownerKind",
"ownerId",
"windowKey",
"metric",
"unit",
"limitValue",
"period",
"periodSeconds",
"anchorAtMs",
"modelPattern",
"enabled"
],
"type": "object"
}Output_QuotaEntryDto
Complete JSON Schema
Referenced structures: Output_QuotaAllowanceDto, Output_QuotaBalanceDto, Output_QuotaBreakdownRowDto
{
"properties": {
"allowance": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_QuotaAllowanceDto"
},
{
"type": "null"
}
],
"description": "Present for `window`, `rate_limit` and `budget`."
},
"balance": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_QuotaBalanceDto"
},
{
"type": "null"
}
],
"description": "Present only for `balance`."
},
"breakdown": {
"items": {
"$ref": "#/components/schemas/Output_QuotaBreakdownRowDto"
},
"type": [
"array",
"null"
]
},
"id": {
"type": "string"
},
"kind": {
"description": "`window`, `rate_limit`, `budget`, `balance` or `breakdown`.",
"type": "string"
},
"label": {
"type": [
"string",
"null"
]
},
"modelScope": {
"description": "The channel's `QuotaScope` JSON: `\"all\"`, `{\"models\":[…]}`, … ."
},
"sourceId": {
"type": "string"
},
"subject": {
"description": "`account`, `organization`, `project`, `key` or `unknown`.",
"type": "string"
}
},
"required": [
"id",
"sourceId",
"label",
"subject",
"modelScope",
"kind",
"allowance",
"balance",
"breakdown"
],
"type": "object"
}Output_QuotaObservationDto
Complete JSON Schema
{
"description": "One persisted upstream reading of one window: a row of the observation\nlog the cycles are built from.",
"properties": {
"credentialId": {
"type": "string"
},
"cycleCostUsd": {
"description": "That cycle's `costUsd` when the reading was taken; the difference\nbetween two readings of one cycle is the USD spent between them.",
"type": [
"string",
"null"
]
},
"cycleId": {
"description": "The cycle the reading fell in, if any.",
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"observedAtMs": {
"format": "int64",
"type": "integer"
},
"resetsAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"scope": true,
"snapshot": {
"description": "The observed `QuotaEntry`, as the channel reported it."
},
"startsAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"id",
"credentialId",
"scope",
"snapshot",
"observedAtMs",
"startsAtMs",
"resetsAtMs",
"cycleId",
"cycleCostUsd"
],
"type": "object"
}Output_QuotaProbeDto
Complete JSON Schema
Referenced structures: Output_QuotaSnapshotDto
{
"description": "An explicit diagnostic probe; responses are redacted and never stored.",
"properties": {
"error": {
"type": [
"string",
"null"
]
},
"responses": {
"items": true,
"type": "array"
},
"snapshot": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_QuotaSnapshotDto"
},
{
"type": "null"
}
]
}
},
"required": [
"snapshot",
"error",
"responses"
],
"type": "object"
}Output_QuotaResetCreditsDto
Complete JSON Schema
Referenced structures: Output_QuotaResetOptionDto
{
"properties": {
"availableCount": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"creditExpirationsMs": {
"items": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": "array"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"options": {
"items": {
"$ref": "#/components/schemas/Output_QuotaResetOptionDto"
},
"type": "array"
}
},
"required": [
"creditExpirationsMs",
"options",
"availableCount",
"expiresAtMs"
],
"type": "object"
}Output_QuotaResetDto
Complete JSON Schema
{
"description": "The outcome of redeeming an upstream reset credit.",
"properties": {
"outcome": {
"description": "`reset`, `nothing_to_reset`, `no_credit`, `already_redeemed`,\n`ineligible`, `unavailable` or `cooldown`.",
"type": "string"
},
"reason": {
"type": [
"string",
"null"
]
},
"windowsReset": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"reason",
"outcome",
"windowsReset"
],
"type": "object"
}Output_QuotaResetOptionDto
Complete JSON Schema
{
"properties": {
"availableCount": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"clears": {
"items": {
"type": "string"
},
"type": "array"
},
"expiresAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"grantId": {
"type": [
"string",
"null"
]
},
"ineligibleReason": {
"type": [
"string",
"null"
]
},
"label": {
"type": [
"string",
"null"
]
},
"nextAvailableAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"program": {
"type": "string"
},
"usable": {
"type": "boolean"
}
},
"required": [
"program",
"grantId",
"label",
"availableCount",
"expiresAtMs",
"nextAvailableAtMs",
"usable",
"ineligibleReason",
"clears"
],
"type": "object"
}Output_QuotaSnapshotDto
Complete JSON Schema
Referenced structures: Output_QuotaEntryDto
{
"description": "One live answer from the upstream, already persisted as cycles and blocks\nby the time it is returned.",
"properties": {
"entries": {
"items": {
"$ref": "#/components/schemas/Output_QuotaEntryDto"
},
"type": "array"
},
"observedAtMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"observedAtMs",
"entries"
],
"type": "object"
}Output_Ranker
Complete JSON Schema
{
"enum": [
"auto",
"default-2024-11-15"
],
"type": "string"
}Output_RankingOptions
Complete JSON Schema
Referenced structures: Output_HybridSearch, Output_Ranker
{
"additionalProperties": true,
"properties": {
"hybrid_search": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_HybridSearch"
},
{
"type": "null"
}
]
},
"ranker": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Ranker"
},
{
"type": "null"
}
]
},
"score_threshold": {
"type": [
"number",
"null"
]
}
},
"type": "object"
}Output_RateLimitDto
Complete JSON Schema
{
"properties": {
"apiKeyId": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"limitValue": {
"description": "A decimal string, never a JSON number: a limit has to survive a\nJavaScript `Number` unchanged.",
"type": "string"
},
"metric": {
"description": "`requests`, `concurrency`, or any counter name the host charges.",
"type": "string"
},
"modelPattern": {
"description": "None means every model.",
"type": [
"string",
"null"
]
},
"periodSeconds": {
"format": "int64",
"type": "integer"
},
"userId": {
"description": "Exactly one subject, the same rule permissions follow.",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"userId",
"apiKeyId",
"metric",
"limitValue",
"periodSeconds",
"modelPattern",
"enabled"
],
"type": "object"
}Output_RateLimitsUpdatedEvent
Complete JSON Schema
Referenced structures: Output_RateLimitsUpdatedEventRateLimit, Output_RateLimitsUpdatedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/rate_limits_updated_event.py`, `RateLimitsUpdatedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"rate_limits": {
"items": {
"$ref": "#/components/schemas/Output_RateLimitsUpdatedEventRateLimit"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_RateLimitsUpdatedEventType"
}
},
"required": [
"event_id",
"rate_limits",
"type"
],
"type": "object"
}Output_RateLimitsUpdatedEventRateLimit
Complete JSON Schema
Referenced structures: Output_RateLimitsUpdatedEventRateLimitName
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/rate_limits_updated_event.py`, `RateLimit`.",
"properties": {
"limit": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RateLimitsUpdatedEventRateLimitName"
},
{
"type": "null"
}
]
},
"remaining": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"reset_seconds": {
"type": [
"number",
"null"
]
}
},
"type": "object"
}Output_RateLimitsUpdatedEventRateLimitName
Complete JSON Schema
{
"enum": [
"requests",
"tokens"
],
"type": "string"
}Output_RateLimitsUpdatedEventType
Complete JSON Schema
{
"enum": [
"rate_limits.updated"
],
"type": "string"
}Output_RealtimeAudioConfig
Complete JSON Schema
Referenced structures: Output_RealtimeAudioConfigInput, Output_RealtimeAudioConfigOutput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config.py`, `RealtimeAudioConfig`.",
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioConfigInput"
},
{
"type": "null"
}
]
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioConfigOutput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeAudioConfigInput
Complete JSON Schema
Referenced structures: Output_AudioTranscription2, Output_RealtimeAudioConfigInputNoiseReduction, Output_RealtimeAudioFormats, Output_RealtimeAudioInputTurnDetection
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_input.py`, `RealtimeAudioConfigInput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"noise_reduction": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioConfigInputNoiseReduction"
},
{
"type": "null"
}
]
},
"transcription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AudioTranscription2"
},
{
"type": "null"
}
]
},
"turn_detection": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioInputTurnDetection"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeAudioConfigInputNoiseReduction
Complete JSON Schema
Referenced structures: Output_NoiseReductionType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_input.py`, `NoiseReduction`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_NoiseReductionType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeAudioConfigOutput
Complete JSON Schema
Referenced structures: Output_RealtimeAudioConfigOutputVoice, Output_RealtimeAudioFormats
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_output.py`, `RealtimeAudioConfigOutput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"speed": {
"type": [
"number",
"null"
]
},
"voice": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioConfigOutputVoice"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeAudioConfigOutputVoice
Complete JSON Schema
Referenced structures: Output_RealtimeAudioConfigOutputVoiceID
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Output_RealtimeAudioConfigOutputVoiceID"
}
],
"description": "Source: `openai/types/realtime/realtime_audio_config_output.py`, `Voice`."
}Output_RealtimeAudioConfigOutputVoiceID
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_config_output.py`, `VoiceID`.",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Output_RealtimeAudioFormats
Complete JSON Schema
Referenced structures: Output_RealtimeAudioFormatsAudioPCM, Output_RealtimeAudioFormatsAudioPCMA, Output_RealtimeAudioFormatsAudioPCMU
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormatsAudioPCM"
},
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormatsAudioPCMU"
},
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormatsAudioPCMA"
}
],
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `RealtimeAudioFormats`."
}Output_RealtimeAudioFormatsAudioPCM
Complete JSON Schema
Referenced structures: Output_RealtimeAudioFormatsAudioPCMRate, Output_RealtimeAudioFormatsAudioPCMType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `AudioPCM`.",
"properties": {
"rate": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormatsAudioPCMRate"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormatsAudioPCMType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeAudioFormatsAudioPCMA
Complete JSON Schema
Referenced structures: Output_RealtimeAudioFormatsAudioPCMAType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `AudioPCMA`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormatsAudioPCMAType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeAudioFormatsAudioPCMAType
Complete JSON Schema
{
"enum": [
"audio/pcma"
],
"type": "string"
}Output_RealtimeAudioFormatsAudioPCMRate
Complete JSON Schema
{
"description": "A numeric literal validated through scalar conversion; object routing remains derived.",
"format": "int64",
"type": "integer"
}Output_RealtimeAudioFormatsAudioPCMType
Complete JSON Schema
{
"enum": [
"audio/pcm"
],
"type": "string"
}Output_RealtimeAudioFormatsAudioPCMU
Complete JSON Schema
Referenced structures: Output_RealtimeAudioFormatsAudioPCMUType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_formats.py`, `AudioPCMU`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormatsAudioPCMUType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeAudioFormatsAudioPCMUType
Complete JSON Schema
{
"enum": [
"audio/pcmu"
],
"type": "string"
}Output_RealtimeAudioInputTurnDetection
Complete JSON Schema
Referenced structures: Output_RealtimeAudioInputTurnDetectionSemanticVad, Output_RealtimeAudioInputTurnDetectionServerVad
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioInputTurnDetectionServerVad"
},
{
"$ref": "#/components/schemas/Output_RealtimeAudioInputTurnDetectionSemanticVad"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_audio_input_turn_detection.py`, `RealtimeAudioInputTurnDetection`."
}Output_RealtimeAudioInputTurnDetectionSemanticVad
Complete JSON Schema
Referenced structures: Output_RealtimeAudioInputTurnDetectionSemanticVadEagerness, Output_RealtimeAudioInputTurnDetectionSemanticVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_input_turn_detection.py`, `SemanticVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"eagerness": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioInputTurnDetectionSemanticVadEagerness"
},
{
"type": "null"
}
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeAudioInputTurnDetectionSemanticVadType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeAudioInputTurnDetectionSemanticVadEagerness
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"auto"
],
"type": "string"
}Output_RealtimeAudioInputTurnDetectionSemanticVadType
Complete JSON Schema
{
"enum": [
"semantic_vad"
],
"type": "string"
}Output_RealtimeAudioInputTurnDetectionServerVad
Complete JSON Schema
Referenced structures: Output_RealtimeAudioInputTurnDetectionServerVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_audio_input_turn_detection.py`, `ServerVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"idle_timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"prefix_padding_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silence_duration_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeAudioInputTurnDetectionServerVadType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeAudioInputTurnDetectionServerVadType
Complete JSON Schema
{
"enum": [
"server_vad"
],
"type": "string"
}Output_RealtimeConversationItemAssistantMessage
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemAssistantMessageContent, Output_RealtimeConversationItemAssistantMessageObject, Output_RealtimeConversationItemAssistantMessageRole, Output_RealtimeConversationItemAssistantMessageStatus, Output_RealtimeConversationItemAssistantMessageType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_assistant_message.py`, `RealtimeConversationItemAssistantMessage`.",
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemAssistantMessageContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemAssistantMessageObject"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemAssistantMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemAssistantMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemAssistantMessageType"
}
},
"required": [
"content",
"role",
"type"
],
"type": "object"
}Output_RealtimeConversationItemAssistantMessageContent
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemAssistantMessageContentType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_assistant_message.py`, `Content`.",
"properties": {
"audio": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemAssistantMessageContentType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeConversationItemAssistantMessageContentType
Complete JSON Schema
{
"enum": [
"output_text",
"output_audio"
],
"type": "string"
}Output_RealtimeConversationItemAssistantMessageObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Output_RealtimeConversationItemAssistantMessageRole
Complete JSON Schema
{
"enum": [
"assistant"
],
"type": "string"
}Output_RealtimeConversationItemAssistantMessageStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Output_RealtimeConversationItemAssistantMessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Output_RealtimeConversationItemFunctionCall
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemFunctionCallObject, Output_RealtimeConversationItemFunctionCallStatus, Output_RealtimeConversationItemFunctionCallType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_function_call.py`, `RealtimeConversationItemFunctionCall`.",
"properties": {
"arguments": {
"type": "string"
},
"call_id": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCallObject"
},
{
"type": "null"
}
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCallStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCallType"
}
},
"required": [
"arguments",
"name",
"type"
],
"type": "object"
}Output_RealtimeConversationItemFunctionCallObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Output_RealtimeConversationItemFunctionCallOutput
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemFunctionCallOutputObject, Output_RealtimeConversationItemFunctionCallOutputStatus, Output_RealtimeConversationItemFunctionCallOutputType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_function_call_output.py`, `RealtimeConversationItemFunctionCallOutput`.",
"properties": {
"call_id": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCallOutputObject"
},
{
"type": "null"
}
]
},
"output": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCallOutputStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemFunctionCallOutputType"
}
},
"required": [
"call_id",
"output",
"type"
],
"type": "object"
}Output_RealtimeConversationItemFunctionCallOutputObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Output_RealtimeConversationItemFunctionCallOutputStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Output_RealtimeConversationItemFunctionCallOutputType
Complete JSON Schema
{
"enum": [
"function_call_output"
],
"type": "string"
}Output_RealtimeConversationItemFunctionCallStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Output_RealtimeConversationItemFunctionCallType
Complete JSON Schema
{
"enum": [
"function_call"
],
"type": "string"
}Output_RealtimeConversationItemSystemMessage
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemSystemMessageContent, Output_RealtimeConversationItemSystemMessageObject, Output_RealtimeConversationItemSystemMessageRole, Output_RealtimeConversationItemSystemMessageStatus, Output_RealtimeConversationItemSystemMessageType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_system_message.py`, `RealtimeConversationItemSystemMessage`.",
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemSystemMessageContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemSystemMessageObject"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemSystemMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemSystemMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemSystemMessageType"
}
},
"required": [
"content",
"role",
"type"
],
"type": "object"
}Output_RealtimeConversationItemSystemMessageContent
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemSystemMessageContentType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_system_message.py`, `Content`.",
"properties": {
"text": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemSystemMessageContentType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeConversationItemSystemMessageContentType
Complete JSON Schema
{
"enum": [
"input_text"
],
"type": "string"
}Output_RealtimeConversationItemSystemMessageObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Output_RealtimeConversationItemSystemMessageRole
Complete JSON Schema
{
"enum": [
"system"
],
"type": "string"
}Output_RealtimeConversationItemSystemMessageStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Output_RealtimeConversationItemSystemMessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Output_RealtimeConversationItemUserMessage
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemUserMessageContent, Output_RealtimeConversationItemUserMessageObject, Output_RealtimeConversationItemUserMessageRole, Output_RealtimeConversationItemUserMessageStatus, Output_RealtimeConversationItemUserMessageType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_user_message.py`, `RealtimeConversationItemUserMessage`.",
"properties": {
"content": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessageContent"
},
"type": "array"
},
"id": {
"type": [
"string",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessageObject"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessageRole"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessageStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessageType"
}
},
"required": [
"content",
"role",
"type"
],
"type": "object"
}Output_RealtimeConversationItemUserMessageContent
Complete JSON Schema
Referenced structures: Output_RealtimeConversationItemUserMessageContentDetail, Output_RealtimeConversationItemUserMessageContentType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_conversation_item_user_message.py`, `Content`.",
"properties": {
"audio": {
"type": [
"string",
"null"
]
},
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessageContentDetail"
},
{
"type": "null"
}
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeConversationItemUserMessageContentType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeConversationItemUserMessageContentDetail
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high"
],
"type": "string"
}Output_RealtimeConversationItemUserMessageContentType
Complete JSON Schema
{
"enum": [
"input_text",
"input_audio",
"input_image"
],
"type": "string"
}Output_RealtimeConversationItemUserMessageObject
Complete JSON Schema
{
"enum": [
"realtime.item"
],
"type": "string"
}Output_RealtimeConversationItemUserMessageRole
Complete JSON Schema
{
"enum": [
"user"
],
"type": "string"
}Output_RealtimeConversationItemUserMessageStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"in_progress"
],
"type": "string"
}Output_RealtimeConversationItemUserMessageType
Complete JSON Schema
{
"enum": [
"message"
],
"type": "string"
}Output_RealtimeError
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_error.py`, `RealtimeError`.",
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"event_id": {
"type": [
"string",
"null"
]
},
"message": {
"type": "string"
},
"param": {
"type": [
"string",
"null"
]
},
"type": {
"type": "string"
}
},
"required": [
"message",
"type"
],
"type": "object"
}Output_RealtimeErrorEvent
Complete JSON Schema
Referenced structures: Output_RealtimeError, Output_RealtimeErrorEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_error_event.py`, `RealtimeErrorEvent`.",
"properties": {
"error": {
"$ref": "#/components/schemas/Output_RealtimeError"
},
"event_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeErrorEventType"
}
},
"required": [
"error",
"event_id",
"type"
],
"type": "object"
}Output_RealtimeErrorEventType
Complete JSON Schema
{
"enum": [
"error"
],
"type": "string"
}Output_RealtimeFunctionTool
Complete JSON Schema
Referenced structures: Output_RealtimeFunctionToolType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_function_tool.py`, `RealtimeFunctionTool`.",
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"parameters": true,
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeFunctionToolType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeFunctionToolType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Output_RealtimeMcpApprovalRequest
Complete JSON Schema
Referenced structures: Output_RealtimeMcpApprovalRequestType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_approval_request.py`, `RealtimeMcpApprovalRequest`.",
"properties": {
"arguments": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeMcpApprovalRequestType"
}
},
"required": [
"id",
"arguments",
"name",
"server_label",
"type"
],
"type": "object"
}Output_RealtimeMcpApprovalRequestType
Complete JSON Schema
{
"enum": [
"mcp_approval_request"
],
"type": "string"
}Output_RealtimeMcpApprovalResponse
Complete JSON Schema
Referenced structures: Output_RealtimeMcpApprovalResponseType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_approval_response.py`, `RealtimeMcpApprovalResponse`.",
"properties": {
"approval_request_id": {
"type": "string"
},
"approve": {
"type": "boolean"
},
"id": {
"type": "string"
},
"reason": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeMcpApprovalResponseType"
}
},
"required": [
"id",
"approval_request_id",
"approve",
"type"
],
"type": "object"
}Output_RealtimeMcpApprovalResponseType
Complete JSON Schema
{
"enum": [
"mcp_approval_response"
],
"type": "string"
}Output_RealtimeMcpListTools
Complete JSON Schema
Referenced structures: Output_RealtimeMcpListToolsTool, Output_RealtimeMcpListToolsType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_list_tools.py`, `RealtimeMcpListTools`.",
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeMcpListToolsTool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeMcpListToolsType"
}
},
"required": [
"server_label",
"tools",
"type"
],
"type": "object"
}Output_RealtimeMcpListToolsTool
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_list_tools.py`, `Tool`.",
"properties": {
"annotations": true,
"description": {
"type": [
"string",
"null"
]
},
"input_schema": true,
"name": {
"type": "string"
}
},
"required": [
"input_schema",
"name"
],
"type": "object"
}Output_RealtimeMcpListToolsType
Complete JSON Schema
{
"enum": [
"mcp_list_tools"
],
"type": "string"
}Output_RealtimeMcpProtocolError
Complete JSON Schema
Referenced structures: Output_RealtimeMcpProtocolErrorType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_protocol_error.py`, `RealtimeMcpProtocolError`.",
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeMcpProtocolErrorType"
}
},
"required": [
"code",
"message",
"type"
],
"type": "object"
}Output_RealtimeMcpProtocolErrorType
Complete JSON Schema
{
"enum": [
"protocol_error"
],
"type": "string"
}Output_RealtimeMcpToolCall
Complete JSON Schema
Referenced structures: Output_RealtimeMcpToolCallError, Output_RealtimeMcpToolCallType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_tool_call.py`, `RealtimeMcpToolCall`.",
"properties": {
"approval_request_id": {
"type": [
"string",
"null"
]
},
"arguments": {
"type": "string"
},
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeMcpToolCallError"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"output": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeMcpToolCallType"
}
},
"required": [
"id",
"arguments",
"name",
"server_label",
"type"
],
"type": "object"
}Output_RealtimeMcpToolCallError
Complete JSON Schema
Referenced structures: Output_RealtimeMcpProtocolError, Output_RealtimeMcpToolExecutionError, Output_RealtimeMcphttpError
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeMcpProtocolError"
},
{
"$ref": "#/components/schemas/Output_RealtimeMcpToolExecutionError"
},
{
"$ref": "#/components/schemas/Output_RealtimeMcphttpError"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_mcp_tool_call.py`, `Error`."
}Output_RealtimeMcpToolCallType
Complete JSON Schema
{
"enum": [
"mcp_call"
],
"type": "string"
}Output_RealtimeMcpToolExecutionError
Complete JSON Schema
Referenced structures: Output_RealtimeMcpToolExecutionErrorType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcp_tool_execution_error.py`, `RealtimeMcpToolExecutionError`.",
"properties": {
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeMcpToolExecutionErrorType"
}
},
"required": [
"message",
"type"
],
"type": "object"
}Output_RealtimeMcpToolExecutionErrorType
Complete JSON Schema
{
"enum": [
"tool_execution_error"
],
"type": "string"
}Output_RealtimeMcphttpError
Complete JSON Schema
Referenced structures: Output_RealtimeMcphttpErrorType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_mcphttp_error.py`, `RealtimeMcphttpError`.",
"properties": {
"code": {
"format": "int64",
"type": "integer"
},
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeMcphttpErrorType"
}
},
"required": [
"code",
"message",
"type"
],
"type": "object"
}Output_RealtimeMcphttpErrorType
Complete JSON Schema
{
"enum": [
"http_error"
],
"type": "string"
}Output_RealtimeReasoning
Complete JSON Schema
Referenced structures: Output_RealtimeReasoningEffort
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_reasoning.py`, `RealtimeReasoning`.",
"properties": {
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeReasoningEffort"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeReasoningEffort
Complete JSON Schema
{
"description": "Source: `openai/types/realtime/realtime_reasoning_effort.py`, `RealtimeReasoningEffort`.",
"enum": [
"minimal",
"low",
"medium",
"high",
"xhigh"
],
"type": "string"
}Output_RealtimeResponse
Complete JSON Schema
Referenced structures: Output_ConversationItem, Output_RealtimeResponseAudio, Output_RealtimeResponseMaxOutputTokens, Output_RealtimeResponseObject, Output_RealtimeResponseOutputModalitiesItem, Output_RealtimeResponseStatus, Output_RealtimeResponseStatusValue, Output_RealtimeResponseUsage
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response.py`, `RealtimeResponse`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseAudio"
},
{
"type": "null"
}
]
},
"conversation_id": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseMaxOutputTokens"
},
{
"type": "null"
}
]
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"object": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseObject"
},
{
"type": "null"
}
]
},
"output": {
"items": {
"$ref": "#/components/schemas/Output_ConversationItem"
},
"type": [
"array",
"null"
]
},
"output_modalities": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeResponseOutputModalitiesItem"
},
"type": [
"array",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseStatusValue"
},
{
"type": "null"
}
]
},
"status_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseStatus"
},
{
"type": "null"
}
]
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseUsage"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeResponseAudio
Complete JSON Schema
Referenced structures: Output_RealtimeResponseAudioOutput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response.py`, `Audio`.",
"properties": {
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseAudioOutput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeResponseAudioOutput
Complete JSON Schema
Referenced structures: Output_RealtimeAudioFormats
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response.py`, `AudioOutput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"voice": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RealtimeResponseMaxOutputTokens
Complete JSON Schema
Referenced structures: Output_RealtimeResponseMaxOutputTokensVariant2
{
"anyOf": [
{
"format": "int64",
"type": "integer"
},
{
"$ref": "#/components/schemas/Output_RealtimeResponseMaxOutputTokensVariant2"
}
]
}Output_RealtimeResponseMaxOutputTokensVariant2
Complete JSON Schema
{
"enum": [
"inf"
],
"type": "string"
}Output_RealtimeResponseObject
Complete JSON Schema
{
"enum": [
"realtime.response"
],
"type": "string"
}Output_RealtimeResponseOutputModalitiesItem
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Output_RealtimeResponseStatus
Complete JSON Schema
Referenced structures: Output_RealtimeResponseStatusError, Output_RealtimeResponseStatusReason, Output_RealtimeResponseStatusType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_status.py`, `RealtimeResponseStatus`.",
"properties": {
"error": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseStatusError"
},
{
"type": "null"
}
]
},
"reason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseStatusReason"
},
{
"type": "null"
}
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseStatusType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeResponseStatusError
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_status.py`, `Error`.",
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RealtimeResponseStatusReason
Complete JSON Schema
{
"enum": [
"turn_detected",
"client_cancelled",
"max_output_tokens",
"content_filter"
],
"type": "string"
}Output_RealtimeResponseStatusType
Complete JSON Schema
{
"enum": [
"completed",
"cancelled",
"incomplete",
"failed"
],
"type": "string"
}Output_RealtimeResponseStatusValue
Complete JSON Schema
{
"enum": [
"completed",
"cancelled",
"failed",
"incomplete",
"in_progress"
],
"type": "string"
}Output_RealtimeResponseUsage
Complete JSON Schema
Referenced structures: Output_RealtimeResponseUsageInputTokenDetails, Output_RealtimeResponseUsageOutputTokenDetails
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_usage.py`, `RealtimeResponseUsage`.",
"properties": {
"input_token_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseUsageInputTokenDetails"
},
{
"type": "null"
}
]
},
"input_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output_token_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseUsageOutputTokenDetails"
},
{
"type": "null"
}
]
},
"output_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_RealtimeResponseUsageInputTokenDetails
Complete JSON Schema
Referenced structures: Output_RealtimeResponseUsageInputTokenDetailsCachedTokensDetails
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_usage_input_token_details.py`, `RealtimeResponseUsageInputTokenDetails`.",
"properties": {
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cached_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cached_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeResponseUsageInputTokenDetailsCachedTokensDetails"
},
{
"type": "null"
}
]
},
"image_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_RealtimeResponseUsageInputTokenDetailsCachedTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_usage_input_token_details.py`, `CachedTokensDetails`.",
"properties": {
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"image_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_RealtimeResponseUsageOutputTokenDetails
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_response_usage_output_token_details.py`, `RealtimeResponseUsageOutputTokenDetails`.",
"properties": {
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_RealtimeServerEvent
Complete JSON Schema
Referenced structures: Output_ConversationCreatedEvent, Output_ConversationItemAdded, Output_ConversationItemCreatedEvent, Output_ConversationItemDeletedEvent, Output_ConversationItemDone, Output_ConversationItemInputAudioTranscriptionCompletedEvent, Output_ConversationItemInputAudioTranscriptionDeltaEvent, Output_ConversationItemInputAudioTranscriptionFailedEvent, Output_ConversationItemInputAudioTranscriptionSegment, Output_ConversationItemRetrieved, Output_ConversationItemTruncatedEvent, Output_InputAudioBufferClearedEvent, Output_InputAudioBufferCommittedEvent, Output_InputAudioBufferDtmfEventReceivedEvent, Output_InputAudioBufferSpeechStartedEvent, Output_InputAudioBufferSpeechStoppedEvent, Output_InputAudioBufferTimeoutTriggered, Output_McpListToolsCompleted, Output_McpListToolsFailed, Output_McpListToolsInProgress, Output_RateLimitsUpdatedEvent, Output_RealtimeErrorEvent, Output_RealtimeServerEventOutputAudioBufferCleared, Output_RealtimeServerEventOutputAudioBufferStarted, Output_RealtimeServerEventOutputAudioBufferStopped, Output_ResponseAudioDeltaEvent, Output_ResponseAudioDoneEvent, Output_ResponseAudioTranscriptDeltaEvent, Output_ResponseAudioTranscriptDoneEvent, Output_ResponseContentPartAddedEvent, Output_ResponseContentPartDoneEvent, Output_ResponseCreatedEvent, Output_ResponseDoneEvent, Output_ResponseFunctionCallArgumentsDeltaEvent, Output_ResponseFunctionCallArgumentsDoneEvent, Output_ResponseMcpCallArgumentsDelta, Output_ResponseMcpCallArgumentsDone, Output_ResponseMcpCallCompleted, Output_ResponseMcpCallFailed, Output_ResponseMcpCallInProgress, Output_ResponseOutputItemAddedEvent, Output_ResponseOutputItemDoneEvent, Output_ResponseTextDeltaEvent, Output_ResponseTextDoneEvent, Output_SessionCreatedEvent, Output_SessionUpdatedEvent
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ConversationCreatedEvent"
},
{
"$ref": "#/components/schemas/Output_ConversationItemCreatedEvent"
},
{
"$ref": "#/components/schemas/Output_ConversationItemDeletedEvent"
},
{
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionCompletedEvent"
},
{
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionDeltaEvent"
},
{
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionFailedEvent"
},
{
"$ref": "#/components/schemas/Output_ConversationItemRetrieved"
},
{
"$ref": "#/components/schemas/Output_ConversationItemTruncatedEvent"
},
{
"$ref": "#/components/schemas/Output_RealtimeErrorEvent"
},
{
"$ref": "#/components/schemas/Output_InputAudioBufferClearedEvent"
},
{
"$ref": "#/components/schemas/Output_InputAudioBufferCommittedEvent"
},
{
"$ref": "#/components/schemas/Output_InputAudioBufferDtmfEventReceivedEvent"
},
{
"$ref": "#/components/schemas/Output_InputAudioBufferSpeechStartedEvent"
},
{
"$ref": "#/components/schemas/Output_InputAudioBufferSpeechStoppedEvent"
},
{
"$ref": "#/components/schemas/Output_RateLimitsUpdatedEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseAudioDeltaEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseAudioDoneEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseAudioTranscriptDeltaEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseAudioTranscriptDoneEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseContentPartAddedEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseContentPartDoneEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseCreatedEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseDoneEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseFunctionCallArgumentsDeltaEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseFunctionCallArgumentsDoneEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseOutputItemAddedEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseOutputItemDoneEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseTextDeltaEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseTextDoneEvent"
},
{
"$ref": "#/components/schemas/Output_SessionCreatedEvent"
},
{
"$ref": "#/components/schemas/Output_SessionUpdatedEvent"
},
{
"$ref": "#/components/schemas/Output_RealtimeServerEventOutputAudioBufferStarted"
},
{
"$ref": "#/components/schemas/Output_RealtimeServerEventOutputAudioBufferStopped"
},
{
"$ref": "#/components/schemas/Output_RealtimeServerEventOutputAudioBufferCleared"
},
{
"$ref": "#/components/schemas/Output_ConversationItemAdded"
},
{
"$ref": "#/components/schemas/Output_ConversationItemDone"
},
{
"$ref": "#/components/schemas/Output_InputAudioBufferTimeoutTriggered"
},
{
"$ref": "#/components/schemas/Output_ConversationItemInputAudioTranscriptionSegment"
},
{
"$ref": "#/components/schemas/Output_McpListToolsInProgress"
},
{
"$ref": "#/components/schemas/Output_McpListToolsCompleted"
},
{
"$ref": "#/components/schemas/Output_McpListToolsFailed"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpCallArgumentsDelta"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpCallArgumentsDone"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpCallInProgress"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpCallCompleted"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpCallFailed"
}
],
"description": "Source: `openai/types/realtime/realtime_server_event.py`, `RealtimeServerEvent`."
}Output_RealtimeServerEventOutputAudioBufferCleared
Complete JSON Schema
Referenced structures: Output_RealtimeServerEventOutputAudioBufferClearedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_server_event.py`, `OutputAudioBufferCleared`.",
"properties": {
"event_id": {
"type": "string"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeServerEventOutputAudioBufferClearedType"
}
},
"required": [
"event_id",
"response_id",
"type"
],
"type": "object"
}Output_RealtimeServerEventOutputAudioBufferClearedType
Complete JSON Schema
{
"enum": [
"output_audio_buffer.cleared"
],
"type": "string"
}Output_RealtimeServerEventOutputAudioBufferStarted
Complete JSON Schema
Referenced structures: Output_RealtimeServerEventOutputAudioBufferStartedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_server_event.py`, `OutputAudioBufferStarted`.",
"properties": {
"event_id": {
"type": "string"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeServerEventOutputAudioBufferStartedType"
}
},
"required": [
"event_id",
"response_id",
"type"
],
"type": "object"
}Output_RealtimeServerEventOutputAudioBufferStartedType
Complete JSON Schema
{
"enum": [
"output_audio_buffer.started"
],
"type": "string"
}Output_RealtimeServerEventOutputAudioBufferStopped
Complete JSON Schema
Referenced structures: Output_RealtimeServerEventOutputAudioBufferStoppedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_server_event.py`, `OutputAudioBufferStopped`.",
"properties": {
"event_id": {
"type": "string"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeServerEventOutputAudioBufferStoppedType"
}
},
"required": [
"event_id",
"response_id",
"type"
],
"type": "object"
}Output_RealtimeServerEventOutputAudioBufferStoppedType
Complete JSON Schema
{
"enum": [
"output_audio_buffer.stopped"
],
"type": "string"
}Output_RealtimeSessionCreateRequest
Complete JSON Schema
Referenced structures: Output_RealtimeAudioConfig, Output_RealtimeReasoning, Output_RealtimeSessionCreateRequestIncludeItem, Output_RealtimeSessionCreateRequestMaxOutputTokens, Output_RealtimeSessionCreateRequestOutputModalitiesItem, Output_RealtimeSessionCreateRequestType, Output_RealtimeToolChoiceConfig, Output_RealtimeToolsConfigUnion, Output_RealtimeTracingConfig, Output_RealtimeTruncation, Output_ResponsePrompt2
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_request.py`, `RealtimeSessionCreateRequest`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioConfig"
},
{
"type": "null"
}
]
},
"include": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateRequestIncludeItem"
},
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateRequestMaxOutputTokens"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"output_modalities": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateRequestOutputModalitiesItem"
},
"type": [
"array",
"null"
]
},
"parallel_tool_calls": {
"type": [
"boolean",
"null"
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponsePrompt2"
},
{
"type": "null"
}
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeReasoning"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeToolChoiceConfig"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnion"
},
"type": [
"array",
"null"
]
},
"tracing": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTracingConfig"
},
{
"type": "null"
}
]
},
"truncation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTruncation"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateRequestType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeSessionCreateRequestIncludeItem
Complete JSON Schema
{
"enum": [
"item.input_audio_transcription.logprobs"
],
"type": "string"
}Output_RealtimeSessionCreateRequestMaxOutputTokens
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateRequestMaxOutputTokensVariant2
{
"anyOf": [
{
"format": "int64",
"type": "integer"
},
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateRequestMaxOutputTokensVariant2"
}
]
}Output_RealtimeSessionCreateRequestMaxOutputTokensVariant2
Complete JSON Schema
{
"enum": [
"inf"
],
"type": "string"
}Output_RealtimeSessionCreateRequestOutputModalitiesItem
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Output_RealtimeSessionCreateRequestType
Complete JSON Schema
{
"enum": [
"realtime"
],
"type": "string"
}Output_RealtimeSessionCreateResponse
Complete JSON Schema
Referenced structures: Output_RealtimeReasoning, Output_RealtimeSessionCreateResponseAudio, Output_RealtimeSessionCreateResponseIncludeItem, Output_RealtimeSessionCreateResponseMaxOutputTokens, Output_RealtimeSessionCreateResponseObject, Output_RealtimeSessionCreateResponseOutputModalitiesItem, Output_RealtimeSessionCreateResponseTool, Output_RealtimeSessionCreateResponseToolChoice, Output_RealtimeSessionCreateResponseTracing, Output_RealtimeSessionCreateResponseType, Output_RealtimeTruncation, Output_ResponsePrompt2
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `RealtimeSessionCreateResponse`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudio"
},
{
"type": "null"
}
]
},
"expires_at": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"type": "string"
},
"include": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseIncludeItem"
},
"type": [
"array",
"null"
]
},
"instructions": {
"type": [
"string",
"null"
]
},
"max_output_tokens": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseMaxOutputTokens"
},
{
"type": "null"
}
]
},
"model": {
"type": [
"string",
"null"
]
},
"object": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseObject"
},
"output_modalities": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseOutputModalitiesItem"
},
"type": [
"array",
"null"
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponsePrompt2"
},
{
"type": "null"
}
]
},
"reasoning": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeReasoning"
},
{
"type": "null"
}
]
},
"tool_choice": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolChoice"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseTool"
},
"type": [
"array",
"null"
]
},
"tracing": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseTracing"
},
{
"type": "null"
}
]
},
"truncation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTruncation"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseType"
}
},
"required": [
"id",
"object",
"type"
],
"type": "object"
}Output_RealtimeSessionCreateResponseAudio
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseAudioInput, Output_RealtimeSessionCreateResponseAudioOutput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `Audio`.",
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInput"
},
{
"type": "null"
}
]
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioOutput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseAudioInput
Complete JSON Schema
Referenced structures: Output_AudioTranscription2, Output_RealtimeAudioFormats, Output_RealtimeSessionCreateResponseAudioInputNoiseReduction, Output_RealtimeSessionCreateResponseAudioInputTurnDetection
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `AudioInput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"noise_reduction": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInputNoiseReduction"
},
{
"type": "null"
}
]
},
"transcription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AudioTranscription2"
},
{
"type": "null"
}
]
},
"turn_detection": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInputTurnDetection"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseAudioInputNoiseReduction
Complete JSON Schema
Referenced structures: Output_NoiseReductionType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `AudioInputNoiseReduction`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_NoiseReductionType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseAudioInputTurnDetection
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVad, Output_RealtimeSessionCreateResponseAudioInputTurnDetectionServerVad
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInputTurnDetectionServerVad"
},
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVad"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `AudioInputTurnDetection`."
}Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVad
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVadEagerness, Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `AudioInputTurnDetectionSemanticVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"eagerness": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVadEagerness"
},
{
"type": "null"
}
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVadType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVadEagerness
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"auto"
],
"type": "string"
}Output_RealtimeSessionCreateResponseAudioInputTurnDetectionSemanticVadType
Complete JSON Schema
{
"enum": [
"semantic_vad"
],
"type": "string"
}Output_RealtimeSessionCreateResponseAudioInputTurnDetectionServerVad
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseAudioInputTurnDetectionServerVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `AudioInputTurnDetectionServerVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"idle_timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"prefix_padding_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silence_duration_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseAudioInputTurnDetectionServerVadType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeSessionCreateResponseAudioInputTurnDetectionServerVadType
Complete JSON Schema
{
"enum": [
"server_vad"
],
"type": "string"
}Output_RealtimeSessionCreateResponseAudioOutput
Complete JSON Schema
Referenced structures: Output_RealtimeAudioFormats
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `AudioOutput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"speed": {
"type": [
"number",
"null"
]
},
"voice": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseIncludeItem
Complete JSON Schema
{
"enum": [
"item.input_audio_transcription.logprobs"
],
"type": "string"
}Output_RealtimeSessionCreateResponseMaxOutputTokens
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseMaxOutputTokensVariant2
{
"anyOf": [
{
"format": "int64",
"type": "integer"
},
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseMaxOutputTokensVariant2"
}
]
}Output_RealtimeSessionCreateResponseMaxOutputTokensVariant2
Complete JSON Schema
{
"enum": [
"inf"
],
"type": "string"
}Output_RealtimeSessionCreateResponseObject
Complete JSON Schema
{
"enum": [
"realtime.session"
],
"type": "string"
}Output_RealtimeSessionCreateResponseOutputModalitiesItem
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Output_RealtimeSessionCreateResponseTool
Complete JSON Schema
Referenced structures: Output_RealtimeFunctionTool, Output_RealtimeSessionCreateResponseToolMcpTool
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeFunctionTool"
},
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpTool"
}
],
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `Tool`."
}Output_RealtimeSessionCreateResponseToolChoice
Complete JSON Schema
Referenced structures: Output_ToolChoiceFunction2, Output_ToolChoiceMcp2, Output_ToolChoiceOptions
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolChoiceOptions"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceFunction2"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceMcp2"
}
],
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolChoice`."
}Output_RealtimeSessionCreateResponseToolMcpTool
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseToolMcpToolAllowedCallersItem, Output_RealtimeSessionCreateResponseToolMcpToolAllowedTools, Output_RealtimeSessionCreateResponseToolMcpToolConnectorId, Output_RealtimeSessionCreateResponseToolMcpToolRequireApproval, Output_RealtimeSessionCreateResponseToolMcpToolType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolMcpTool`.",
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolAllowedCallersItem"
},
"type": [
"array",
"null"
]
},
"allowed_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolAllowedTools"
},
{
"type": "null"
}
]
},
"authorization": {
"type": [
"string",
"null"
]
},
"connector_id": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolConnectorId"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"require_approval": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolRequireApproval"
},
{
"type": "null"
}
]
},
"server_description": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"server_url": {
"type": [
"string",
"null"
]
},
"tunnel_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolType"
}
},
"required": [
"server_label",
"type"
],
"type": "object"
}Output_RealtimeSessionCreateResponseToolMcpToolAllowedCallersItem
Complete JSON Schema
{
"enum": [
"direct",
"programmatic"
],
"type": "string"
}Output_RealtimeSessionCreateResponseToolMcpToolAllowedTools
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseToolMcpToolAllowedToolsMcpToolFilter
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolAllowedToolsMcpToolFilter"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolMcpToolAllowedTools`."
}Output_RealtimeSessionCreateResponseToolMcpToolAllowedToolsMcpToolFilter
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolMcpToolAllowedToolsMcpToolFilter`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseToolMcpToolConnectorId
Complete JSON Schema
{
"enum": [
"connector_dropbox",
"connector_gmail",
"connector_googlecalendar",
"connector_googledrive",
"connector_microsoftteams",
"connector_outlookcalendar",
"connector_outlookemail",
"connector_sharepoint"
],
"type": "string"
}Output_RealtimeSessionCreateResponseToolMcpToolRequireApproval
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilter, Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalVariant2
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilter"
},
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalVariant2"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolMcpToolRequireApproval`."
}Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilter
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilterAlways, Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilterNever
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolMcpToolRequireApprovalMcpToolApprovalFilter`.",
"properties": {
"always": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilterAlways"
},
{
"type": "null"
}
]
},
"never": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilterNever"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilterAlways
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolMcpToolRequireApprovalMcpToolApprovalFilterAlways`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalMcpToolApprovalFilterNever
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `ToolMcpToolRequireApprovalMcpToolApprovalFilterNever`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseToolMcpToolRequireApprovalVariant2
Complete JSON Schema
{
"enum": [
"always",
"never"
],
"type": "string"
}Output_RealtimeSessionCreateResponseToolMcpToolType
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Output_RealtimeSessionCreateResponseTracing
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateResponseTracingTracingConfiguration, Output_RealtimeSessionCreateResponseTracingVariant1
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseTracingVariant1"
},
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateResponseTracingTracingConfiguration"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `Tracing`."
}Output_RealtimeSessionCreateResponseTracingTracingConfiguration
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_session_create_response.py`, `TracingTracingConfiguration`.",
"properties": {
"group_id": {
"type": [
"string",
"null"
]
},
"metadata": true,
"workflow_name": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RealtimeSessionCreateResponseTracingVariant1
Complete JSON Schema
{
"enum": [
"auto"
],
"type": "string"
}Output_RealtimeSessionCreateResponseType
Complete JSON Schema
{
"enum": [
"realtime"
],
"type": "string"
}Output_RealtimeToolChoiceConfig
Complete JSON Schema
Referenced structures: Output_ToolChoiceFunction2, Output_ToolChoiceMcp2, Output_ToolChoiceOptions
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolChoiceOptions"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceFunction2"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceMcp2"
}
],
"description": "Source: `openai/types/realtime/realtime_tool_choice_config.py`, `RealtimeToolChoiceConfig`."
}Output_RealtimeToolsConfigUnion
Complete JSON Schema
Referenced structures: Output_RealtimeFunctionTool, Output_RealtimeToolsConfigUnionMcp
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeFunctionTool"
},
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcp"
}
],
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `RealtimeToolsConfigUnion`."
}Output_RealtimeToolsConfigUnionMcp
Complete JSON Schema
Referenced structures: Output_RealtimeToolsConfigUnionMcpAllowedCallersItem, Output_RealtimeToolsConfigUnionMcpAllowedTools, Output_RealtimeToolsConfigUnionMcpConnectorId, Output_RealtimeToolsConfigUnionMcpRequireApproval, Output_RealtimeToolsConfigUnionMcpType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `Mcp`.",
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpAllowedCallersItem"
},
"type": [
"array",
"null"
]
},
"allowed_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpAllowedTools"
},
{
"type": "null"
}
]
},
"authorization": {
"type": [
"string",
"null"
]
},
"connector_id": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpConnectorId"
},
{
"type": "null"
}
]
},
"defer_loading": {
"type": [
"boolean",
"null"
]
},
"headers": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"require_approval": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpRequireApproval"
},
{
"type": "null"
}
]
},
"server_description": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"server_url": {
"type": [
"string",
"null"
]
},
"tunnel_id": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpType"
}
},
"required": [
"server_label",
"type"
],
"type": "object"
}Output_RealtimeToolsConfigUnionMcpAllowedCallersItem
Complete JSON Schema
{
"enum": [
"direct",
"programmatic"
],
"type": "string"
}Output_RealtimeToolsConfigUnionMcpAllowedTools
Complete JSON Schema
Referenced structures: Output_RealtimeToolsConfigUnionMcpAllowedToolsMcpToolFilter
{
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpAllowedToolsMcpToolFilter"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpAllowedTools`."
}Output_RealtimeToolsConfigUnionMcpAllowedToolsMcpToolFilter
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpAllowedToolsMcpToolFilter`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_RealtimeToolsConfigUnionMcpConnectorId
Complete JSON Schema
{
"enum": [
"connector_dropbox",
"connector_gmail",
"connector_googlecalendar",
"connector_googledrive",
"connector_microsoftteams",
"connector_outlookcalendar",
"connector_outlookemail",
"connector_sharepoint"
],
"type": "string"
}Output_RealtimeToolsConfigUnionMcpRequireApproval
Complete JSON Schema
Referenced structures: Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilter, Output_RealtimeToolsConfigUnionMcpRequireApprovalVariant2
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilter"
},
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpRequireApprovalVariant2"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApproval`."
}Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilter
Complete JSON Schema
Referenced structures: Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterAlways, Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterNever
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApprovalMcpToolApprovalFilter`.",
"properties": {
"always": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterAlways"
},
{
"type": "null"
}
]
},
"never": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterNever"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterAlways
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApprovalMcpToolApprovalFilterAlways`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_RealtimeToolsConfigUnionMcpRequireApprovalMcpToolApprovalFilterNever
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tools_config_union.py`, `McpRequireApprovalMcpToolApprovalFilterNever`.",
"properties": {
"read_only": {
"type": [
"boolean",
"null"
]
},
"tool_names": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_RealtimeToolsConfigUnionMcpRequireApprovalVariant2
Complete JSON Schema
{
"enum": [
"always",
"never"
],
"type": "string"
}Output_RealtimeToolsConfigUnionMcpType
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Output_RealtimeTracingConfig
Complete JSON Schema
Referenced structures: Output_RealtimeTracingConfigTracingConfiguration, Output_RealtimeTracingConfigVariant1
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTracingConfigVariant1"
},
{
"$ref": "#/components/schemas/Output_RealtimeTracingConfigTracingConfiguration"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_tracing_config.py`, `RealtimeTracingConfig`."
}Output_RealtimeTracingConfigTracingConfiguration
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_tracing_config.py`, `TracingConfiguration`.",
"properties": {
"group_id": {
"type": [
"string",
"null"
]
},
"metadata": true,
"workflow_name": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RealtimeTracingConfigVariant1
Complete JSON Schema
{
"enum": [
"auto"
],
"type": "string"
}Output_RealtimeTranscriptionSessionAudio
Complete JSON Schema
Referenced structures: Output_RealtimeTranscriptionSessionAudioInput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio.py`, `RealtimeTranscriptionSessionAudio`.",
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeTranscriptionSessionAudioInput
Complete JSON Schema
Referenced structures: Output_AudioTranscription2, Output_RealtimeAudioFormats, Output_RealtimeTranscriptionSessionAudioInputNoiseReduction, Output_RealtimeTranscriptionSessionAudioInputTurnDetection
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input.py`, `RealtimeTranscriptionSessionAudioInput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"noise_reduction": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInputNoiseReduction"
},
{
"type": "null"
}
]
},
"transcription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AudioTranscription2"
},
{
"type": "null"
}
]
},
"turn_detection": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInputTurnDetection"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeTranscriptionSessionAudioInputNoiseReduction
Complete JSON Schema
Referenced structures: Output_NoiseReductionType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input.py`, `NoiseReduction`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_NoiseReductionType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeTranscriptionSessionAudioInputTurnDetection
Complete JSON Schema
Referenced structures: Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVad, Output_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVad
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVad"
},
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVad"
},
{
"type": "null"
}
],
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input_turn_detection.py`, `RealtimeTranscriptionSessionAudioInputTurnDetection`."
}Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVad
Complete JSON Schema
Referenced structures: Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadEagerness, Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input_turn_detection.py`, `SemanticVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"eagerness": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadEagerness"
},
{
"type": "null"
}
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadEagerness
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"auto"
],
"type": "string"
}Output_RealtimeTranscriptionSessionAudioInputTurnDetectionSemanticVadType
Complete JSON Schema
{
"enum": [
"semantic_vad"
],
"type": "string"
}Output_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVad
Complete JSON Schema
Referenced structures: Output_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVadType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_audio_input_turn_detection.py`, `ServerVad`.",
"properties": {
"create_response": {
"type": [
"boolean",
"null"
]
},
"idle_timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"interrupt_response": {
"type": [
"boolean",
"null"
]
},
"prefix_padding_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silence_duration_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVadType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeTranscriptionSessionAudioInputTurnDetectionServerVadType
Complete JSON Schema
{
"enum": [
"server_vad"
],
"type": "string"
}Output_RealtimeTranscriptionSessionCreateRequest
Complete JSON Schema
Referenced structures: Output_RealtimeTranscriptionSessionAudio, Output_RealtimeTranscriptionSessionCreateRequestIncludeItem, Output_RealtimeTranscriptionSessionCreateRequestType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_create_request.py`, `RealtimeTranscriptionSessionCreateRequest`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionAudio"
},
{
"type": "null"
}
]
},
"include": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateRequestIncludeItem"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateRequestType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RealtimeTranscriptionSessionCreateRequestIncludeItem
Complete JSON Schema
{
"enum": [
"item.input_audio_transcription.logprobs"
],
"type": "string"
}Output_RealtimeTranscriptionSessionCreateRequestType
Complete JSON Schema
{
"enum": [
"transcription"
],
"type": "string"
}Output_RealtimeTranscriptionSessionCreateResponse
Complete JSON Schema
Referenced structures: Output_RealtimeTranscriptionSessionCreateResponseAudio, Output_RealtimeTranscriptionSessionCreateResponseIncludeItem, Output_RealtimeTranscriptionSessionCreateResponseType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_create_response.py`, `RealtimeTranscriptionSessionCreateResponse`.",
"properties": {
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateResponseAudio"
},
{
"type": "null"
}
]
},
"expires_at": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"id": {
"type": "string"
},
"include": {
"items": {
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateResponseIncludeItem"
},
"type": [
"array",
"null"
]
},
"object": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateResponseType"
}
},
"required": [
"id",
"object",
"type"
],
"type": "object"
}Output_RealtimeTranscriptionSessionCreateResponseAudio
Complete JSON Schema
Referenced structures: Output_RealtimeTranscriptionSessionCreateResponseAudioInput
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_create_response.py`, `Audio`.",
"properties": {
"input": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateResponseAudioInput"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeTranscriptionSessionCreateResponseAudioInput
Complete JSON Schema
Referenced structures: Output_AudioTranscription2, Output_RealtimeAudioFormats, Output_RealtimeTranscriptionSessionCreateResponseAudioInputNoiseReduction, Output_RealtimeTranscriptionSessionTurnDetection
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_create_response.py`, `AudioInput`.",
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeAudioFormats"
},
{
"type": "null"
}
]
},
"noise_reduction": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateResponseAudioInputNoiseReduction"
},
{
"type": "null"
}
]
},
"transcription": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_AudioTranscription2"
},
{
"type": "null"
}
]
},
"turn_detection": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionTurnDetection"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeTranscriptionSessionCreateResponseAudioInputNoiseReduction
Complete JSON Schema
Referenced structures: Output_NoiseReductionType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_create_response.py`, `AudioInputNoiseReduction`.",
"properties": {
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_NoiseReductionType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_RealtimeTranscriptionSessionCreateResponseIncludeItem
Complete JSON Schema
{
"enum": [
"item.input_audio_transcription.logprobs"
],
"type": "string"
}Output_RealtimeTranscriptionSessionCreateResponseType
Complete JSON Schema
{
"enum": [
"transcription"
],
"type": "string"
}Output_RealtimeTranscriptionSessionTurnDetection
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_transcription_session_turn_detection.py`, `RealtimeTranscriptionSessionTurnDetection`.",
"properties": {
"prefix_padding_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"silence_duration_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RealtimeTruncation
Complete JSON Schema
Referenced structures: Output_RealtimeTruncationRetentionRatio, Output_RealtimeTruncationVariant1
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTruncationVariant1"
},
{
"$ref": "#/components/schemas/Output_RealtimeTruncationRetentionRatio"
}
],
"description": "Source: `openai/types/realtime/realtime_truncation.py`, `RealtimeTruncation`."
}Output_RealtimeTruncationRetentionRatio
Complete JSON Schema
Referenced structures: Output_RealtimeTruncationRetentionRatioTokenLimits, Output_RealtimeTruncationRetentionRatioType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_truncation_retention_ratio.py`, `RealtimeTruncationRetentionRatio`.",
"properties": {
"retention_ratio": {
"type": "number"
},
"token_limits": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeTruncationRetentionRatioTokenLimits"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_RealtimeTruncationRetentionRatioType"
}
},
"required": [
"retention_ratio",
"type"
],
"type": "object"
}Output_RealtimeTruncationRetentionRatioTokenLimits
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/realtime_truncation_retention_ratio.py`, `TokenLimits`.",
"properties": {
"post_instructions": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_RealtimeTruncationRetentionRatioType
Complete JSON Schema
{
"enum": [
"retention_ratio"
],
"type": "string"
}Output_RealtimeTruncationVariant1
Complete JSON Schema
{
"enum": [
"auto",
"disabled"
],
"type": "string"
}Output_ReasoningConfig
Complete JSON Schema
Referenced structures: Output_ReasoningContext, Output_ReasoningEffort, Output_ReasoningSummary
{
"additionalProperties": true,
"properties": {
"context": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningContext"
},
{
"type": "null"
}
]
},
"effort": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningEffort"
},
{
"type": "null"
}
]
},
"generate_summary": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningSummary"
},
{
"type": "null"
}
]
},
"mode": {
"type": [
"string",
"null"
]
},
"summary": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningSummary"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ReasoningContent
Complete JSON Schema
Referenced structures: Output_ReasoningTextType
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ReasoningTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_ReasoningContext
Complete JSON Schema
{
"enum": [
"auto",
"current_turn",
"all_turns"
],
"type": "string"
}Output_ReasoningDetail
Complete JSON Schema
Referenced structures: Output_ReasoningDetailKind
{
"additionalProperties": true,
"description": "Payload fields are optional because streaming detail fragments may carry\nonly a signature or identity. Encrypted data is never interpreted as text.",
"properties": {
"data": {
"type": [
"string",
"null"
]
},
"format": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"index": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"signature": {
"type": [
"string",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ReasoningDetailKind"
}
},
"required": [
"type"
],
"type": "object"
}Output_ReasoningDetailKind
Complete JSON Schema
{
"enum": [
"reasoning.text",
"reasoning.summary",
"reasoning.encrypted"
],
"type": "string"
}Output_ReasoningEffort
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh",
"max"
],
"type": "string"
},
{
"description": "Codex custom effort is serialized as an unsigned JSON integer.",
"format": "uint64",
"minimum": 0,
"type": "integer"
}
]
}Output_ReasoningItem
Complete JSON Schema
Referenced structures: Output_Agent, Output_ReasoningContent, Output_ReasoningItemType, Output_ReasoningStatus, Output_SummaryText
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Output_ReasoningContent"
},
"type": [
"array",
"null"
]
},
"encrypted_content": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ReasoningStatus"
},
{
"type": "null"
}
]
},
"summary": {
"items": {
"$ref": "#/components/schemas/Output_SummaryText"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_ReasoningItemType"
}
},
"required": [
"type",
"id",
"summary"
],
"type": "object"
}Output_ReasoningItemType
Complete JSON Schema
{
"enum": [
"reasoning"
],
"type": "string"
}Output_ReasoningStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"completed",
"incomplete"
],
"type": "string"
}Output_ReasoningSummary
Complete JSON Schema
{
"enum": [
"auto",
"concise",
"detailed"
],
"type": "string"
}Output_ReasoningSummaryPart
Complete JSON Schema
Referenced structures: Output_ReasoningSummaryPartType
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ReasoningSummaryPartType"
}
},
"required": [
"text",
"type"
],
"type": "object"
}Output_ReasoningSummaryPartAddedEvent
Complete JSON Schema
Referenced structures: Output_Agent, Output_ReasoningSummaryPart
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"part": {
"$ref": "#/components/schemas/Output_ReasoningSummaryPart"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"summary_index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"summary_index",
"part"
],
"type": "object"
}Output_ReasoningSummaryPartDoneEvent
Complete JSON Schema
Referenced structures: Output_Agent, Output_ReasoningSummaryPart, Output_SummaryPartStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"part": {
"$ref": "#/components/schemas/Output_ReasoningSummaryPart"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SummaryPartStatus"
},
{
"type": "null"
}
]
},
"summary_index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"summary_index",
"part"
],
"type": "object"
}Output_ReasoningSummaryPartType
Complete JSON Schema
{
"enum": [
"summary_text"
],
"type": "string"
}Output_ReasoningSummaryTextDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"summary_index": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"summary_index",
"delta"
],
"type": "object"
}Output_ReasoningSummaryTextDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"summary_index": {
"format": "int64",
"type": "integer"
},
"text": {
"type": "string"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"summary_index",
"text"
],
"type": "object"
}Output_ReasoningText
Complete JSON Schema
Referenced structures: Output_ReasoningTextType2
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ReasoningTextType2"
}
},
"required": [
"text",
"type"
],
"type": "object"
}Output_ReasoningTextDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content_index": {
"format": "int64",
"type": "integer"
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"delta"
],
"type": "object"
}Output_ReasoningTextDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content_index": {
"format": "int64",
"type": "integer"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"text": {
"type": "string"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"text"
],
"type": "object"
}Output_ReasoningTextType
Complete JSON Schema
{
"enum": [
"reasoning_text"
],
"type": "string"
}Output_ReasoningTextType2
Complete JSON Schema
{
"enum": [
"reasoning_text"
],
"type": "string"
}Output_RedactedThinkingBlock
Complete JSON Schema
Referenced structures: Output_RedactedThinkingBlockType
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_RedactedThinkingBlockType"
}
},
"required": [
"type",
"data"
],
"type": "object"
}Output_RedactedThinkingBlockType
Complete JSON Schema
{
"enum": [
"redacted_thinking"
],
"type": "string"
}Output_RefusalCategory
Complete JSON Schema
{
"enum": [
"cyber",
"bio",
"frontier_llm",
"reasoning_extraction",
"general_harms"
],
"type": "string"
}Output_RefusalDelta
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content_index": {
"format": "int64",
"type": "integer"
},
"delta": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"delta"
],
"type": "object"
}Output_RefusalDone
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content_index": {
"format": "int64",
"type": "integer"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"refusal": {
"type": "string"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index",
"content_index",
"refusal"
],
"type": "object"
}Output_RefusalStopDetails
Complete JSON Schema
Referenced structures: Output_RefusalCategory, Output_RefusalStopDetailsType
{
"additionalProperties": true,
"properties": {
"category": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RefusalCategory"
},
{
"type": "null"
}
]
},
"explanation": {
"type": [
"string",
"null"
]
},
"fallback_credit_token": {
"type": [
"string",
"null"
]
},
"fallback_has_prefill_claim": {
"type": [
"boolean",
"null"
]
},
"recommended_model": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_RefusalStopDetailsType"
}
},
"required": [
"type"
],
"type": "object"
}Output_RefusalStopDetailsType
Complete JSON Schema
{
"enum": [
"refusal"
],
"type": "string"
}Output_ReplayOutputText
Complete JSON Schema
Referenced structures: Output_OutputAnnotation, Output_OutputLogprob, Output_ResponseOutputTextType
{
"additionalProperties": true,
"properties": {
"annotations": {
"items": {
"$ref": "#/components/schemas/Output_OutputAnnotation"
},
"type": [
"array",
"null"
]
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_OutputLogprob"
},
"type": [
"array",
"null"
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseOutputTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_RequiredSteeringInput
Complete JSON Schema
Referenced structures: Output_SteeringToolSearchExecution
{
"oneOf": [
{
"properties": {
"call_id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"const": "function_call_output",
"type": "string"
}
},
"required": [
"type",
"call_id",
"name"
],
"type": "object"
},
{
"properties": {
"call_id": {
"type": "string"
},
"type": {
"const": "custom_tool_call_output",
"type": "string"
}
},
"required": [
"type",
"call_id"
],
"type": "object"
},
{
"properties": {
"call_id": {
"type": "string"
},
"type": {
"const": "computer_call_output",
"type": "string"
}
},
"required": [
"type",
"call_id"
],
"type": "object"
},
{
"properties": {
"call_id": {
"type": "string"
},
"type": {
"const": "shell_call_output",
"type": "string"
}
},
"required": [
"type",
"call_id"
],
"type": "object"
},
{
"properties": {
"call_id": {
"type": "string"
},
"type": {
"const": "apply_patch_call_output",
"type": "string"
}
},
"required": [
"type",
"call_id"
],
"type": "object"
},
{
"properties": {
"call_id": {
"type": "string"
},
"execution": {
"$ref": "#/components/schemas/Output_SteeringToolSearchExecution"
},
"type": {
"const": "tool_search_output",
"type": "string"
}
},
"required": [
"type",
"call_id",
"execution"
],
"type": "object"
},
{
"properties": {
"approval_request_id": {
"type": "string"
},
"type": {
"const": "mcp_approval_response",
"type": "string"
}
},
"required": [
"type",
"approval_request_id"
],
"type": "object"
}
]
}Output_RerankDocument
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"image": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RerankResponseBody
Complete JSON Schema
Referenced structures: Output_RerankResult, Output_RerankUsage
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"model": {
"type": "string"
},
"provider": {
"type": [
"string",
"null"
]
},
"results": {
"items": {
"$ref": "#/components/schemas/Output_RerankResult"
},
"type": "array"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RerankUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"model",
"results"
],
"type": "object"
}Output_RerankResult
Complete JSON Schema
Referenced structures: Output_RerankDocument
{
"additionalProperties": true,
"properties": {
"document": {
"$ref": "#/components/schemas/Output_RerankDocument"
},
"index": {
"format": "int64",
"type": "integer"
},
"relevance_score": {
"type": "number"
}
},
"required": [
"index",
"relevance_score",
"document"
],
"type": "object"
}Output_RerankUsage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"cost": {
"type": [
"number",
"null"
]
},
"search_units": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_ResponseAccessPrograms
Complete JSON Schema
Referenced structures: Output_CyberAccessProgram2
{
"additionalProperties": true,
"properties": {
"cyber": {
"$ref": "#/components/schemas/Output_CyberAccessProgram2"
}
},
"required": [
"cyber"
],
"type": "object"
}Output_ResponseAdditionalTools
Complete JSON Schema
Referenced structures: Output_AdditionalToolsType, Output_Agent, Output_ResponseAdditionalToolsRole, Output_Tool
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"role": {
"$ref": "#/components/schemas/Output_ResponseAdditionalToolsRole"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_Tool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_AdditionalToolsType"
}
},
"required": [
"id",
"role",
"tools",
"type"
],
"type": "object"
}Output_ResponseAdditionalToolsRole
Complete JSON Schema
{
"enum": [
"unknown",
"user",
"assistant",
"system",
"critic",
"discriminator",
"developer",
"tool"
],
"type": "string"
}Output_ResponseAdvisorRedactedResult
Complete JSON Schema
Referenced structures: Output_ResponseAdvisorRedactedResultType
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
},
"stop_reason": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseAdvisorRedactedResultType"
}
},
"required": [
"type",
"encrypted_content"
],
"type": "object"
}Output_ResponseAdvisorRedactedResultType
Complete JSON Schema
{
"enum": [
"advisor_redacted_result"
],
"type": "string"
}Output_ResponseAdvisorResult
Complete JSON Schema
Referenced structures: Output_ResponseAdvisorResultType
{
"additionalProperties": true,
"properties": {
"stop_reason": {
"type": [
"string",
"null"
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseAdvisorResultType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_ResponseAdvisorResultContent
Complete JSON Schema
Referenced structures: Output_AdvisorError, Output_ResponseAdvisorRedactedResult, Output_ResponseAdvisorResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_AdvisorError"
},
{
"$ref": "#/components/schemas/Output_ResponseAdvisorResult"
},
{
"$ref": "#/components/schemas/Output_ResponseAdvisorRedactedResult"
}
]
}Output_ResponseAdvisorResultType
Complete JSON Schema
{
"enum": [
"advisor_result"
],
"type": "string"
}Output_ResponseAdvisorToolResultBlock
Complete JSON Schema
Referenced structures: Output_ResponseAdvisorResultContent, Output_ResponseAdvisorToolResultBlockType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_ResponseAdvisorResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseAdvisorToolResultBlockType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Output_ResponseAdvisorToolResultBlockType
Complete JSON Schema
{
"enum": [
"advisor_tool_result"
],
"type": "string"
}Output_ResponseAgentMessage
Complete JSON Schema
Referenced structures: Output_Agent, Output_AgentContent, Output_AgentMessageType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"author": {
"type": "string"
},
"content": {
"items": {
"$ref": "#/components/schemas/Output_AgentContent"
},
"type": "array"
},
"id": {
"type": "string"
},
"recipient": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_AgentMessageType"
}
},
"required": [
"type",
"id",
"author",
"recipient",
"content"
],
"type": "object"
}Output_ResponseApplyPatchCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_ApplyPatchCallType, Output_ApplyPatchOperation, Output_ApplyPatchStatus, Output_Caller
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"operation": {
"$ref": "#/components/schemas/Output_ApplyPatchOperation"
},
"status": {
"$ref": "#/components/schemas/Output_ApplyPatchStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ApplyPatchCallType"
}
},
"required": [
"id",
"call_id",
"operation",
"status",
"type"
],
"type": "object"
}Output_ResponseApplyPatchCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ApplyPatchCallOutputType, Output_ApplyPatchOutputStatus, Output_Caller
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"output": {
"type": [
"string",
"null"
]
},
"status": {
"$ref": "#/components/schemas/Output_ApplyPatchOutputStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ApplyPatchCallOutputType"
}
},
"required": [
"id",
"call_id",
"status",
"type"
],
"type": "object"
}Output_ResponseAudio
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"data": {
"type": "string"
},
"expires_at": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"transcript": {
"type": "string"
}
},
"required": [
"id",
"data",
"expires_at",
"transcript"
],
"type": "object"
}Output_ResponseAudioDeltaEvent
Complete JSON Schema
Referenced structures: Output_ResponseAudioDeltaEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_audio_delta_event.py`, `ResponseAudioDeltaEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"delta": {
"type": "string"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseAudioDeltaEventType"
}
},
"required": [
"content_index",
"delta",
"event_id",
"item_id",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseAudioDeltaEventType
Complete JSON Schema
{
"enum": [
"response.output_audio.delta"
],
"type": "string"
}Output_ResponseAudioDoneEvent
Complete JSON Schema
Referenced structures: Output_ResponseAudioDoneEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_audio_done_event.py`, `ResponseAudioDoneEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseAudioDoneEventType"
}
},
"required": [
"content_index",
"event_id",
"item_id",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseAudioDoneEventType
Complete JSON Schema
{
"enum": [
"response.output_audio.done"
],
"type": "string"
}Output_ResponseAudioTranscriptDeltaEvent
Complete JSON Schema
Referenced structures: Output_ResponseAudioTranscriptDeltaEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_audio_transcript_delta_event.py`, `ResponseAudioTranscriptDeltaEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"delta": {
"type": "string"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseAudioTranscriptDeltaEventType"
}
},
"required": [
"content_index",
"delta",
"event_id",
"item_id",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseAudioTranscriptDeltaEventType
Complete JSON Schema
{
"enum": [
"response.output_audio_transcript.delta"
],
"type": "string"
}Output_ResponseAudioTranscriptDoneEvent
Complete JSON Schema
Referenced structures: Output_ResponseAudioTranscriptDoneEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_audio_transcript_done_event.py`, `ResponseAudioTranscriptDoneEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"transcript": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseAudioTranscriptDoneEventType"
}
},
"required": [
"content_index",
"event_id",
"item_id",
"output_index",
"response_id",
"transcript",
"type"
],
"type": "object"
}Output_ResponseAudioTranscriptDoneEventType
Complete JSON Schema
{
"enum": [
"response.output_audio_transcript.done"
],
"type": "string"
}Output_ResponseBashCodeExecutionToolResultBlock
Complete JSON Schema
Referenced structures: Output_BashCodeExecutionResultContent, Output_ResponseBashCodeExecutionToolResultBlockType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_BashCodeExecutionResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseBashCodeExecutionToolResultBlockType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Output_ResponseBashCodeExecutionToolResultBlockType
Complete JSON Schema
{
"enum": [
"bash_code_execution_tool_result"
],
"type": "string"
}Output_ResponseCharCitation
Complete JSON Schema
Referenced structures: Output_ResponseCharCitationType
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"document_index": {
"format": "int64",
"type": "integer"
},
"document_title": {
"type": [
"string",
"null"
]
},
"end_char_index": {
"format": "int64",
"type": "integer"
},
"file_id": {
"type": [
"string",
"null"
]
},
"start_char_index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseCharCitationType"
}
},
"required": [
"type",
"cited_text",
"document_index",
"end_char_index",
"start_char_index"
],
"type": "object"
}Output_ResponseCharCitationType
Complete JSON Schema
{
"enum": [
"char_location"
],
"type": "string"
}Output_ResponseCitationConfig
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled"
],
"type": "object"
}Output_ResponseCodeExecutionToolResultBlock
Complete JSON Schema
Referenced structures: Output_CodeExecutionResultContent, Output_ResponseCodeExecutionToolResultBlockType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_CodeExecutionResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseCodeExecutionToolResultBlockType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Output_ResponseCodeExecutionToolResultBlockType
Complete JSON Schema
{
"enum": [
"code_execution_tool_result"
],
"type": "string"
}Output_ResponseCompaction
Complete JSON Schema
Referenced structures: Output_Agent, Output_CompactionType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"encrypted_content": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_CompactionType"
}
},
"required": [
"id",
"encrypted_content",
"type"
],
"type": "object"
}Output_ResponseCompactionBlock
Complete JSON Schema
Referenced structures: Output_ResponseCompactionBlockType
{
"additionalProperties": true,
"properties": {
"content": {
"type": [
"string",
"null"
]
},
"encrypted_content": {
"type": [
"string",
"null"
]
},
"signature": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseCompactionBlockType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ResponseCompactionBlockType
Complete JSON Schema
{
"enum": [
"compaction"
],
"type": "string"
}Output_ResponseCompleted
Complete JSON Schema
Referenced structures: Output_GenerateContentResponseBody
{
"additionalProperties": true,
"properties": {
"response": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBody"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response"
],
"type": "object"
}Output_ResponseComputerCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ComputerCallOutputType, Output_ComputerScreenshot, Output_PendingSafetyCheck, Output_ResponseComputerOutputStatus
{
"additionalProperties": true,
"properties": {
"acknowledged_safety_checks": {
"items": {
"$ref": "#/components/schemas/Output_PendingSafetyCheck"
},
"type": [
"array",
"null"
]
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"created_by": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"output": {
"$ref": "#/components/schemas/Output_ComputerScreenshot"
},
"status": {
"$ref": "#/components/schemas/Output_ResponseComputerOutputStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ComputerCallOutputType"
}
},
"required": [
"id",
"call_id",
"output",
"status",
"type"
],
"type": "object"
}Output_ResponseComputerOutputStatus
Complete JSON Schema
{
"enum": [
"completed",
"incomplete",
"failed",
"in_progress"
],
"type": "string"
}Output_ResponseContainer
Complete JSON Schema
Referenced structures: Output_ResponseSkill
{
"additionalProperties": true,
"properties": {
"expires_at": {
"type": "string"
},
"id": {
"type": "string"
},
"skills": {
"items": {
"$ref": "#/components/schemas/Output_ResponseSkill"
},
"type": [
"array",
"null"
]
}
},
"required": [
"id",
"expires_at"
],
"type": "object"
}Output_ResponseContainerUploadBlock
Complete JSON Schema
Referenced structures: Output_ResponseContainerUploadBlockType
{
"additionalProperties": true,
"properties": {
"file_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseContainerUploadBlockType"
}
},
"required": [
"type",
"file_id"
],
"type": "object"
}Output_ResponseContainerUploadBlockType
Complete JSON Schema
{
"enum": [
"container_upload"
],
"type": "string"
}Output_ResponseContentBlock
Complete JSON Schema
Referenced structures: Output_McpToolListingBlock, Output_RedactedThinkingBlock, Output_ResponseAdvisorToolResultBlock, Output_ResponseBashCodeExecutionToolResultBlock, Output_ResponseCodeExecutionToolResultBlock, Output_ResponseCompactionBlock, Output_ResponseContainerUploadBlock, Output_ResponseFallbackBlock, Output_ResponseMcpToolResultBlock, Output_ResponseMcpToolUseBlock, Output_ResponseServerToolUseBlock, Output_ResponseTextBlock, Output_ResponseTextEditorCodeExecutionToolResultBlock, Output_ResponseToolSearchToolResultBlock, Output_ResponseToolUseBlock, Output_ResponseWebFetchToolResultBlock, Output_ResponseWebSearchToolResultBlock, Output_ThinkingBlock
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseTextBlock"
},
{
"$ref": "#/components/schemas/Output_ThinkingBlock"
},
{
"$ref": "#/components/schemas/Output_RedactedThinkingBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseToolUseBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseServerToolUseBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseWebSearchToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseWebFetchToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseAdvisorToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseCodeExecutionToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseBashCodeExecutionToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseTextEditorCodeExecutionToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseToolSearchToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_McpToolListingBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpToolUseBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpToolResultBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseContainerUploadBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseCompactionBlock"
},
{
"$ref": "#/components/schemas/Output_ResponseFallbackBlock"
}
]
}Output_ResponseContentBlockCitation
Complete JSON Schema
Referenced structures: Output_ResponseContentBlockCitationType
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"document_index": {
"format": "int64",
"type": "integer"
},
"document_title": {
"type": [
"string",
"null"
]
},
"end_block_index": {
"format": "int64",
"type": "integer"
},
"file_id": {
"type": [
"string",
"null"
]
},
"start_block_index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseContentBlockCitationType"
}
},
"required": [
"type",
"cited_text",
"document_index",
"end_block_index",
"start_block_index"
],
"type": "object"
}Output_ResponseContentBlockCitationType
Complete JSON Schema
{
"enum": [
"content_block_location"
],
"type": "string"
}Output_ResponseContentPartAddedEvent
Complete JSON Schema
Referenced structures: Output_ResponseContentPartAddedEventPart, Output_ResponseContentPartAddedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_content_part_added_event.py`, `ResponseContentPartAddedEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"part": {
"$ref": "#/components/schemas/Output_ResponseContentPartAddedEventPart"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseContentPartAddedEventType"
}
},
"required": [
"content_index",
"event_id",
"item_id",
"output_index",
"part",
"response_id",
"type"
],
"type": "object"
}Output_ResponseContentPartAddedEventPart
Complete JSON Schema
Referenced structures: Output_ResponseContentPartAddedEventPartType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_content_part_added_event.py`, `Part`.",
"properties": {
"audio": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseContentPartAddedEventPartType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ResponseContentPartAddedEventPartType
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Output_ResponseContentPartAddedEventType
Complete JSON Schema
{
"enum": [
"response.content_part.added"
],
"type": "string"
}Output_ResponseContentPartDoneEvent
Complete JSON Schema
Referenced structures: Output_ResponseContentPartDoneEventPart, Output_ResponseContentPartDoneEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_content_part_done_event.py`, `ResponseContentPartDoneEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"part": {
"$ref": "#/components/schemas/Output_ResponseContentPartDoneEventPart"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseContentPartDoneEventType"
}
},
"required": [
"content_index",
"event_id",
"item_id",
"output_index",
"part",
"response_id",
"type"
],
"type": "object"
}Output_ResponseContentPartDoneEventPart
Complete JSON Schema
Referenced structures: Output_ResponseContentPartDoneEventPartType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_content_part_done_event.py`, `Part`.",
"properties": {
"audio": {
"type": [
"string",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"transcript": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseContentPartDoneEventPartType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ResponseContentPartDoneEventPartType
Complete JSON Schema
{
"enum": [
"text",
"audio"
],
"type": "string"
}Output_ResponseContentPartDoneEventType
Complete JSON Schema
{
"enum": [
"response.content_part.done"
],
"type": "string"
}Output_ResponseConversationParam
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}Output_ResponseCreated
Complete JSON Schema
Referenced structures: Output_GenerateContentResponseBody
{
"additionalProperties": true,
"properties": {
"response": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBody"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response"
],
"type": "object"
}Output_ResponseCreatedEvent
Complete JSON Schema
Referenced structures: Output_RealtimeResponse, Output_ResponseCreatedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_created_event.py`, `ResponseCreatedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/Output_RealtimeResponse"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseCreatedEventType"
}
},
"required": [
"event_id",
"response",
"type"
],
"type": "object"
}Output_ResponseCreatedEventType
Complete JSON Schema
{
"enum": [
"response.created"
],
"type": "string"
}Output_ResponseCustomToolCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_CustomOutput, Output_CustomToolCallOutputType, Output_ItemStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"output": {
"$ref": "#/components/schemas/Output_CustomOutput"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Output_CustomToolCallOutputType"
}
},
"required": [
"id",
"call_id",
"output",
"status",
"type"
],
"type": "object"
}Output_ResponseDocumentBlock
Complete JSON Schema
Referenced structures: Output_ResponseCitationConfig, Output_ResponseDocumentBlockType, Output_ResponseDocumentSource
{
"additionalProperties": true,
"properties": {
"citations": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseCitationConfig"
},
{
"type": "null"
}
]
},
"source": {
"$ref": "#/components/schemas/Output_ResponseDocumentSource"
},
"title": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseDocumentBlockType"
}
},
"required": [
"type",
"source"
],
"type": "object"
}Output_ResponseDocumentBlockType
Complete JSON Schema
{
"enum": [
"document"
],
"type": "string"
}Output_ResponseDocumentSource
Complete JSON Schema
Referenced structures: Output_PdfBase64Source, Output_PlainTextSource
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_PdfBase64Source",
"properties": {
"type": {
"const": "base64",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_PlainTextSource",
"properties": {
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ResponseDoneEvent
Complete JSON Schema
Referenced structures: Output_RealtimeResponse, Output_ResponseDoneEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_done_event.py`, `ResponseDoneEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"response": {
"$ref": "#/components/schemas/Output_RealtimeResponse"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseDoneEventType"
}
},
"required": [
"event_id",
"response",
"type"
],
"type": "object"
}Output_ResponseDoneEventType
Complete JSON Schema
{
"enum": [
"response.done"
],
"type": "string"
}Output_ResponseError
Complete JSON Schema
Referenced structures: Output_MisalignmentDetails, Output_ResponseErrorCode
{
"additionalProperties": true,
"properties": {
"code": {
"$ref": "#/components/schemas/Output_ResponseErrorCode"
},
"message": {
"type": "string"
},
"misalignment": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MisalignmentDetails"
},
{
"type": "null"
}
]
},
"param": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
}
},
"required": [
"code",
"message"
],
"type": "object"
}Output_ResponseErrorCode
Complete JSON Schema
{
"anyOf": [
{
"enum": [
"server_error",
"rate_limit_exceeded",
"invalid_prompt",
"data_residency_mismatch",
"bio_policy",
"vector_store_timeout",
"invalid_image",
"invalid_image_format",
"invalid_base64_image",
"invalid_image_url",
"image_too_large",
"image_too_small",
"image_parse_error",
"image_content_policy_violation",
"invalid_image_mode",
"image_file_too_large",
"unsupported_image_media_type",
"empty_image_file",
"failed_to_download_image",
"image_file_not_found"
],
"type": "string"
},
{
"description": "Preserve backend-specific and future error codes verbatim.",
"type": "string"
}
]
}Output_ResponseErrorEvent
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"code": {
"type": [
"string",
"null"
]
},
"message": {
"type": "string"
},
"param": {
"type": [
"string",
"null"
]
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"code",
"message",
"param",
"sequence_number"
],
"type": "object"
}Output_ResponseFailed
Complete JSON Schema
Referenced structures: Output_GenerateContentResponseBody
{
"additionalProperties": true,
"properties": {
"response": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBody"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response"
],
"type": "object"
}Output_ResponseFallbackBlock
Complete JSON Schema
Referenced structures: Output_FallbackInfo, Output_FallbackRefusalTrigger, Output_ResponseFallbackBlockType
{
"additionalProperties": true,
"properties": {
"from": {
"$ref": "#/components/schemas/Output_FallbackInfo"
},
"to": {
"$ref": "#/components/schemas/Output_FallbackInfo"
},
"trigger": {
"$ref": "#/components/schemas/Output_FallbackRefusalTrigger"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseFallbackBlockType"
}
},
"required": [
"type",
"from",
"to",
"trigger"
],
"type": "object"
}Output_ResponseFallbackBlockType
Complete JSON Schema
{
"enum": [
"fallback"
],
"type": "string"
}Output_ResponseFunctionCallArgumentsDeltaEvent
Complete JSON Schema
Referenced structures: Output_ResponseFunctionCallArgumentsDeltaEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_function_call_arguments_delta_event.py`, `ResponseFunctionCallArgumentsDeltaEvent`.",
"properties": {
"call_id": {
"type": "string"
},
"delta": {
"type": "string"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseFunctionCallArgumentsDeltaEventType"
}
},
"required": [
"call_id",
"delta",
"event_id",
"item_id",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseFunctionCallArgumentsDeltaEventType
Complete JSON Schema
{
"enum": [
"response.function_call_arguments.delta"
],
"type": "string"
}Output_ResponseFunctionCallArgumentsDoneEvent
Complete JSON Schema
Referenced structures: Output_ResponseFunctionCallArgumentsDoneEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_function_call_arguments_done_event.py`, `ResponseFunctionCallArgumentsDoneEvent`.",
"properties": {
"arguments": {
"type": "string"
},
"call_id": {
"type": "string"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"name": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseFunctionCallArgumentsDoneEventType"
}
},
"required": [
"arguments",
"call_id",
"event_id",
"item_id",
"name",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseFunctionCallArgumentsDoneEventType
Complete JSON Schema
{
"enum": [
"response.function_call_arguments.done"
],
"type": "string"
}Output_ResponseFunctionCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_CustomOutput, Output_FunctionCallOutputType, Output_ItemStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": [
"string",
"null"
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"name": {
"type": [
"string",
"null"
]
},
"namespace": {
"type": [
"string",
"null"
]
},
"output": {
"$ref": "#/components/schemas/Output_CustomOutput"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Output_FunctionCallOutputType"
}
},
"required": [
"id",
"output",
"status",
"type"
],
"type": "object"
}Output_ResponseInProgress
Complete JSON Schema
Referenced structures: Output_GenerateContentResponseBody
{
"additionalProperties": true,
"properties": {
"response": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBody"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response"
],
"type": "object"
}Output_ResponseIncomplete
Complete JSON Schema
Referenced structures: Output_GenerateContentResponseBody
{
"additionalProperties": true,
"properties": {
"response": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBody"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response"
],
"type": "object"
}Output_ResponseIncompleteDetails
Complete JSON Schema
Referenced structures: Output_ResponseIncompleteReason
{
"additionalProperties": true,
"properties": {
"reason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseIncompleteReason"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ResponseIncompleteReason
Complete JSON Schema
{
"enum": [
"max_messages",
"steered",
"interrupted",
"max_output_tokens",
"content_filter"
],
"type": "string"
}Output_ResponseInputFile
Complete JSON Schema
Referenced structures: Output_FileDetail, Output_PromptCacheBreakpoint, Output_ResponseInputFileType
{
"additionalProperties": true,
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FileDetail"
},
{
"type": "null"
}
]
},
"file_data": {
"type": [
"string",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"file_url": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputFileType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ResponseInputFile2
Complete JSON Schema
Referenced structures: Output_ResponseInputFileDetail, Output_ResponseInputFilePromptCacheBreakpoint, Output_ResponseInputFileType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_file.py`, `ResponseInputFile`.",
"properties": {
"detail": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseInputFileDetail"
},
{
"type": "null"
}
]
},
"file_data": {
"type": [
"string",
"null"
]
},
"file_id": {
"type": [
"string",
"null"
]
},
"file_url": {
"type": [
"string",
"null"
]
},
"filename": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseInputFilePromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputFileType2"
}
},
"required": [
"type"
],
"type": "object"
}Output_ResponseInputFileDetail
Complete JSON Schema
{
"enum": [
"auto",
"low",
"high"
],
"type": "string"
}Output_ResponseInputFilePromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Output_ResponseInputFilePromptCacheBreakpointMode
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_file.py`, `PromptCacheBreakpoint`.",
"properties": {
"mode": {
"$ref": "#/components/schemas/Output_ResponseInputFilePromptCacheBreakpointMode"
}
},
"required": [
"mode"
],
"type": "object"
}Output_ResponseInputFilePromptCacheBreakpointMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Output_ResponseInputFileType
Complete JSON Schema
{
"enum": [
"input_file"
],
"type": "string"
}Output_ResponseInputFileType2
Complete JSON Schema
{
"enum": [
"input_file"
],
"type": "string"
}Output_ResponseInputImage
Complete JSON Schema
Referenced structures: Output_ImageDetail, Output_PromptCacheBreakpoint, Output_ResponseInputImageType
{
"additionalProperties": true,
"properties": {
"detail": {
"$ref": "#/components/schemas/Output_ImageDetail"
},
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputImageType"
}
},
"required": [
"type",
"detail"
],
"type": "object"
}Output_ResponseInputImage2
Complete JSON Schema
Referenced structures: Output_ImageDetail2, Output_ResponseInputImagePromptCacheBreakpoint, Output_ResponseInputImageType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_image.py`, `ResponseInputImage`.",
"properties": {
"detail": {
"$ref": "#/components/schemas/Output_ImageDetail2"
},
"file_id": {
"type": [
"string",
"null"
]
},
"image_url": {
"type": [
"string",
"null"
]
},
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseInputImagePromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputImageType2"
}
},
"required": [
"detail",
"type"
],
"type": "object"
}Output_ResponseInputImagePromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Output_ResponseInputImagePromptCacheBreakpointMode
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_image.py`, `PromptCacheBreakpoint`.",
"properties": {
"mode": {
"$ref": "#/components/schemas/Output_ResponseInputImagePromptCacheBreakpointMode"
}
},
"required": [
"mode"
],
"type": "object"
}Output_ResponseInputImagePromptCacheBreakpointMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Output_ResponseInputImageType
Complete JSON Schema
{
"enum": [
"input_image"
],
"type": "string"
}Output_ResponseInputImageType2
Complete JSON Schema
{
"enum": [
"input_image"
],
"type": "string"
}Output_ResponseInputText
Complete JSON Schema
Referenced structures: Output_PromptCacheBreakpoint, Output_ResponseInputTextType
{
"additionalProperties": true,
"properties": {
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_ResponseInputText2
Complete JSON Schema
Referenced structures: Output_ResponseInputTextPromptCacheBreakpoint, Output_ResponseInputTextType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_text.py`, `ResponseInputText`.",
"properties": {
"prompt_cache_breakpoint": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseInputTextPromptCacheBreakpoint"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseInputTextType2"
}
},
"required": [
"text",
"type"
],
"type": "object"
}Output_ResponseInputTextPromptCacheBreakpoint
Complete JSON Schema
Referenced structures: Output_ResponseInputTextPromptCacheBreakpointMode
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_input_text.py`, `PromptCacheBreakpoint`.",
"properties": {
"mode": {
"$ref": "#/components/schemas/Output_ResponseInputTextPromptCacheBreakpointMode"
}
},
"required": [
"mode"
],
"type": "object"
}Output_ResponseInputTextPromptCacheBreakpointMode
Complete JSON Schema
{
"enum": [
"explicit"
],
"type": "string"
}Output_ResponseInputTextType
Complete JSON Schema
{
"enum": [
"input_text"
],
"type": "string"
}Output_ResponseInputTextType2
Complete JSON Schema
{
"enum": [
"input_text"
],
"type": "string"
}Output_ResponseInputTokensDetails
Complete JSON Schema
Referenced structures: Output_CacheWriteTokensDetails
{
"additionalProperties": true,
"properties": {
"cache_write_tokens": {
"format": "int64",
"type": "integer"
},
"cache_write_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheWriteTokensDetails"
},
{
"type": "null"
}
]
},
"cached_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"cache_write_tokens",
"cached_tokens"
],
"type": "object"
}Output_ResponseLocalEnvironment
Complete JSON Schema
Referenced structures: Output_ShellLocalType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_ShellLocalType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ResponseMcpApprovalResponse
Complete JSON Schema
Referenced structures: Output_Agent, Output_McpApprovalResponseType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"approval_request_id": {
"type": "string"
},
"approve": {
"type": "boolean"
},
"id": {
"type": "string"
},
"reason": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_McpApprovalResponseType"
}
},
"required": [
"id",
"approval_request_id",
"approve",
"type"
],
"type": "object"
}Output_ResponseMcpCallArgumentsDelta
Complete JSON Schema
Referenced structures: Output_ResponseMcpCallArgumentsDeltaType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_mcp_call_arguments_delta.py`, `ResponseMcpCallArgumentsDelta`.",
"properties": {
"delta": {
"type": "string"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"obfuscation": {
"type": [
"string",
"null"
]
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseMcpCallArgumentsDeltaType"
}
},
"required": [
"delta",
"event_id",
"item_id",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseMcpCallArgumentsDeltaType
Complete JSON Schema
{
"enum": [
"response.mcp_call_arguments.delta"
],
"type": "string"
}Output_ResponseMcpCallArgumentsDone
Complete JSON Schema
Referenced structures: Output_ResponseMcpCallArgumentsDoneType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_mcp_call_arguments_done.py`, `ResponseMcpCallArgumentsDone`.",
"properties": {
"arguments": {
"type": "string"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseMcpCallArgumentsDoneType"
}
},
"required": [
"arguments",
"event_id",
"item_id",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseMcpCallArgumentsDoneType
Complete JSON Schema
{
"enum": [
"response.mcp_call_arguments.done"
],
"type": "string"
}Output_ResponseMcpCallCompleted
Complete JSON Schema
Referenced structures: Output_ResponseMcpCallCompletedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_mcp_call_completed.py`, `ResponseMcpCallCompleted`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseMcpCallCompletedType"
}
},
"required": [
"event_id",
"item_id",
"output_index",
"type"
],
"type": "object"
}Output_ResponseMcpCallCompletedType
Complete JSON Schema
{
"enum": [
"response.mcp_call.completed"
],
"type": "string"
}Output_ResponseMcpCallFailed
Complete JSON Schema
Referenced structures: Output_ResponseMcpCallFailedType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_mcp_call_failed.py`, `ResponseMcpCallFailed`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseMcpCallFailedType"
}
},
"required": [
"event_id",
"item_id",
"output_index",
"type"
],
"type": "object"
}Output_ResponseMcpCallFailedType
Complete JSON Schema
{
"enum": [
"response.mcp_call.failed"
],
"type": "string"
}Output_ResponseMcpCallInProgress
Complete JSON Schema
Referenced structures: Output_ResponseMcpCallInProgressType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_mcp_call_in_progress.py`, `ResponseMcpCallInProgress`.",
"properties": {
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseMcpCallInProgressType"
}
},
"required": [
"event_id",
"item_id",
"output_index",
"type"
],
"type": "object"
}Output_ResponseMcpCallInProgressType
Complete JSON Schema
{
"enum": [
"response.mcp_call.in_progress"
],
"type": "string"
}Output_ResponseMcpResultContent
Complete JSON Schema
Referenced structures: Output_ResponseTextBlock
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Output_ResponseTextBlock"
},
"type": "array"
}
]
}Output_ResponseMcpToolResultBlock
Complete JSON Schema
Referenced structures: Output_ResponseMcpResultContent, Output_ResponseMcpToolResultBlockType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_ResponseMcpResultContent"
},
"is_error": {
"type": "boolean"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseMcpToolResultBlockType"
}
},
"required": [
"type",
"content",
"is_error",
"tool_use_id"
],
"type": "object"
}Output_ResponseMcpToolResultBlockType
Complete JSON Schema
{
"enum": [
"mcp_tool_result"
],
"type": "string"
}Output_ResponseMcpToolUseBlock
Complete JSON Schema
Referenced structures: Output_ResponseMcpToolUseBlockType
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"input": {
"additionalProperties": true,
"type": "object"
},
"name": {
"type": "string"
},
"server_name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseMcpToolUseBlockType"
}
},
"required": [
"type",
"id",
"input",
"name",
"server_name"
],
"type": "object"
}Output_ResponseMcpToolUseBlockType
Complete JSON Schema
{
"enum": [
"mcp_tool_use"
],
"type": "string"
}Output_ResponseMessage
Complete JSON Schema
Referenced structures: Output_Annotation, Output_FunctionCall3, Output_MessageToolCall, Output_ReasoningDetail, Output_ResponseAudio, Output_ResponseRole2
{
"additionalProperties": true,
"properties": {
"annotations": {
"items": {
"$ref": "#/components/schemas/Output_Annotation"
},
"type": [
"array",
"null"
]
},
"audio": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseAudio"
},
{
"type": "null"
}
]
},
"content": {
"default": null,
"type": [
"string",
"null"
]
},
"function_call": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FunctionCall3"
},
{
"type": "null"
}
]
},
"reasoning": {
"description": "Alternative compatible-provider spelling. Kept separately on the wire.",
"type": [
"string",
"null"
]
},
"reasoning_content": {
"description": "Plain-text reasoning returned by compatible providers (for example DeepSeek).",
"type": [
"string",
"null"
]
},
"reasoning_details": {
"items": {
"$ref": "#/components/schemas/Output_ReasoningDetail"
},
"type": [
"array",
"null"
]
},
"refusal": {
"default": null,
"type": [
"string",
"null"
]
},
"role": {
"$ref": "#/components/schemas/Output_ResponseRole2"
},
"tool_calls": {
"items": {
"$ref": "#/components/schemas/Output_MessageToolCall"
},
"type": [
"array",
"null"
]
}
},
"required": [
"content",
"refusal",
"role"
],
"type": "object"
}Output_ResponseMetadata
Complete JSON Schema
{
"additionalProperties": true,
"description": "Codex turn headers and opaque moderation/verification or buffering metadata.\nThese are stream notifications, distinct from user-supplied Response.metadata.",
"properties": {
"headers": true,
"metadata": true,
"response_id": {
"type": [
"string",
"null"
]
},
"safety_buffering": true,
"sequence_number": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_ResponseModerationError
Complete JSON Schema
Referenced structures: Output_ResponseModerationErrorType
{
"additionalProperties": true,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseModerationErrorType"
}
},
"required": [
"code",
"message",
"type"
],
"type": "object"
}Output_ResponseModerationErrorType
Complete JSON Schema
{
"enum": [
"error"
],
"type": "string"
}Output_ResponseModerationInputType
Complete JSON Schema
{
"enum": [
"text",
"image"
],
"type": "string"
}Output_ResponseModerationOutcome
Complete JSON Schema
Referenced structures: Output_ResponseModerationError, Output_ResponseModerationResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseModerationResult"
},
{
"$ref": "#/components/schemas/Output_ResponseModerationError"
}
]
}Output_ResponseModerationReport
Complete JSON Schema
Referenced structures: Output_ResponseModerationOutcome
{
"additionalProperties": true,
"properties": {
"input": {
"$ref": "#/components/schemas/Output_ResponseModerationOutcome"
},
"output": {
"$ref": "#/components/schemas/Output_ResponseModerationOutcome"
}
},
"required": [
"input",
"output"
],
"type": "object"
}Output_ResponseModerationResult
Complete JSON Schema
Referenced structures: Output_ResponseModerationInputType, Output_ResponseModerationResultType
{
"additionalProperties": true,
"properties": {
"categories": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"category_applied_input_types": {
"additionalProperties": {
"items": {
"$ref": "#/components/schemas/Output_ResponseModerationInputType"
},
"type": "array"
},
"type": "object"
},
"category_scores": {
"additionalProperties": {
"type": "number"
},
"type": "object"
},
"flagged": {
"type": "boolean"
},
"model": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseModerationResultType"
}
},
"required": [
"categories",
"category_applied_input_types",
"category_scores",
"flagged",
"model",
"type"
],
"type": "object"
}Output_ResponseModerationResultType
Complete JSON Schema
{
"enum": [
"moderation_result"
],
"type": "string"
}Output_ResponseMultiAgentCall
Complete JSON Schema
Referenced structures: Output_Action, Output_Agent, Output_MultiAgentCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Output_Action"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": {
"type": "string"
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_MultiAgentCallType"
}
},
"required": [
"type",
"id",
"action",
"arguments",
"call_id"
],
"type": "object"
}Output_ResponseMultiAgentCallOutput
Complete JSON Schema
Referenced structures: Output_Action, Output_Agent, Output_MultiAgentCallOutputType, Output_ResponseOutputText
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Output_Action"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"id": {
"type": "string"
},
"output": {
"items": {
"$ref": "#/components/schemas/Output_ResponseOutputText"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_MultiAgentCallOutputType"
}
},
"required": [
"type",
"id",
"action",
"call_id",
"output"
],
"type": "object"
}Output_ResponseNestedErrorEvent
Complete JSON Schema
Referenced structures: Output_ErrorDetail
{
"additionalProperties": true,
"properties": {
"error": {
"$ref": "#/components/schemas/Output_ErrorDetail"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"error"
],
"type": "object"
}Output_ResponseObject
Complete JSON Schema
{
"enum": [
"response"
],
"type": "string"
}Output_ResponseOutputItem
Complete JSON Schema
Referenced structures: Output_CodeInterpreterCall, Output_ComputerCall, Output_ConfigurationUpdate, Output_CustomToolCall, Output_FileSearchCall, Output_FunctionCall, Output_ImageGenerationCall, Output_LocalShellCall, Output_LocalShellCallOutput, Output_McpApprovalRequest, Output_McpCall, Output_McpListTools, Output_Program, Output_ProgramOutput, Output_ReasoningItem, Output_ResponseAdditionalTools, Output_ResponseAgentMessage, Output_ResponseApplyPatchCall, Output_ResponseApplyPatchCallOutput, Output_ResponseCompaction, Output_ResponseComputerCallOutput, Output_ResponseCustomToolCallOutput, Output_ResponseFunctionCallOutput, Output_ResponseMcpApprovalResponse, Output_ResponseMultiAgentCall, Output_ResponseMultiAgentCallOutput, Output_ResponseOutputMessage, Output_ResponseShellCall, Output_ResponseShellCallOutput, Output_ResponseToolSearchCall, Output_ResponseToolSearchOutput, Output_WebSearchCall
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseMultiAgentCall"
},
{
"$ref": "#/components/schemas/Output_ResponseMultiAgentCallOutput"
},
{
"$ref": "#/components/schemas/Output_ResponseAgentMessage"
},
{
"$ref": "#/components/schemas/Output_ConfigurationUpdate"
},
{
"$ref": "#/components/schemas/Output_ResponseOutputMessage"
},
{
"$ref": "#/components/schemas/Output_FileSearchCall"
},
{
"$ref": "#/components/schemas/Output_FunctionCall"
},
{
"$ref": "#/components/schemas/Output_ResponseFunctionCallOutput"
},
{
"$ref": "#/components/schemas/Output_WebSearchCall"
},
{
"$ref": "#/components/schemas/Output_ComputerCall"
},
{
"$ref": "#/components/schemas/Output_ResponseComputerCallOutput"
},
{
"$ref": "#/components/schemas/Output_ReasoningItem"
},
{
"$ref": "#/components/schemas/Output_Program"
},
{
"$ref": "#/components/schemas/Output_ProgramOutput"
},
{
"$ref": "#/components/schemas/Output_ResponseToolSearchCall"
},
{
"$ref": "#/components/schemas/Output_ResponseToolSearchOutput"
},
{
"$ref": "#/components/schemas/Output_ResponseAdditionalTools"
},
{
"$ref": "#/components/schemas/Output_ResponseCompaction"
},
{
"$ref": "#/components/schemas/Output_ImageGenerationCall"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterCall"
},
{
"$ref": "#/components/schemas/Output_LocalShellCall"
},
{
"$ref": "#/components/schemas/Output_LocalShellCallOutput"
},
{
"$ref": "#/components/schemas/Output_ResponseShellCall"
},
{
"$ref": "#/components/schemas/Output_ResponseShellCallOutput"
},
{
"$ref": "#/components/schemas/Output_ResponseApplyPatchCall"
},
{
"$ref": "#/components/schemas/Output_ResponseApplyPatchCallOutput"
},
{
"$ref": "#/components/schemas/Output_McpCall"
},
{
"$ref": "#/components/schemas/Output_McpListTools"
},
{
"$ref": "#/components/schemas/Output_McpApprovalRequest"
},
{
"$ref": "#/components/schemas/Output_ResponseMcpApprovalResponse"
},
{
"$ref": "#/components/schemas/Output_CustomToolCall"
},
{
"$ref": "#/components/schemas/Output_ResponseCustomToolCallOutput"
}
],
"description": "Native output items; input-only messages/references/triggers are excluded.\nSame-shape items are reused; response-specific required fields use separate structs."
}Output_ResponseOutputItemAddedEvent
Complete JSON Schema
Referenced structures: Output_ConversationItem, Output_ResponseOutputItemAddedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_output_item_added_event.py`, `ResponseOutputItemAddedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/Output_ConversationItem"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseOutputItemAddedEventType"
}
},
"required": [
"event_id",
"item",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseOutputItemAddedEventType
Complete JSON Schema
{
"enum": [
"response.output_item.added"
],
"type": "string"
}Output_ResponseOutputItemDoneEvent
Complete JSON Schema
Referenced structures: Output_ConversationItem, Output_ResponseOutputItemDoneEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_output_item_done_event.py`, `ResponseOutputItemDoneEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"item": {
"$ref": "#/components/schemas/Output_ConversationItem"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseOutputItemDoneEventType"
}
},
"required": [
"event_id",
"item",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseOutputItemDoneEventType
Complete JSON Schema
{
"enum": [
"response.output_item.done"
],
"type": "string"
}Output_ResponseOutputMessage
Complete JSON Schema
Referenced structures: Output_Agent, Output_MessagePhase, Output_MessageType, Output_OutputContent, Output_OutputMessageRole, Output_OutputMessageStatus
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Output_OutputContent"
},
"type": "array"
},
"id": {
"type": "string"
},
"phase": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MessagePhase"
},
{
"type": "null"
}
]
},
"role": {
"$ref": "#/components/schemas/Output_OutputMessageRole"
},
"status": {
"$ref": "#/components/schemas/Output_OutputMessageStatus"
},
"type": {
"$ref": "#/components/schemas/Output_MessageType"
}
},
"required": [
"id",
"content",
"role",
"status",
"type"
],
"type": "object"
}Output_ResponseOutputRefusal
Complete JSON Schema
Referenced structures: Output_ResponseOutputRefusalType
{
"additionalProperties": true,
"properties": {
"refusal": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseOutputRefusalType"
}
},
"required": [
"type",
"refusal"
],
"type": "object"
}Output_ResponseOutputRefusalType
Complete JSON Schema
{
"enum": [
"refusal"
],
"type": "string"
}Output_ResponseOutputText
Complete JSON Schema
Referenced structures: Output_OutputAnnotation, Output_OutputLogprob, Output_ResponseOutputTextType
{
"additionalProperties": true,
"properties": {
"annotations": {
"items": {
"$ref": "#/components/schemas/Output_OutputAnnotation"
},
"type": "array"
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_OutputLogprob"
},
"type": "array"
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseOutputTextType"
}
},
"required": [
"type",
"text",
"annotations",
"logprobs"
],
"type": "object"
}Output_ResponseOutputTextType
Complete JSON Schema
{
"enum": [
"output_text"
],
"type": "string"
}Output_ResponseOutputTokensDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"reasoning_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"reasoning_tokens"
],
"type": "object"
}Output_ResponsePageCitation
Complete JSON Schema
Referenced structures: Output_ResponsePageCitationType
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"document_index": {
"format": "int64",
"type": "integer"
},
"document_title": {
"type": [
"string",
"null"
]
},
"end_page_number": {
"format": "int64",
"type": "integer"
},
"file_id": {
"type": [
"string",
"null"
]
},
"start_page_number": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_ResponsePageCitationType"
}
},
"required": [
"type",
"cited_text",
"document_index",
"end_page_number",
"start_page_number"
],
"type": "object"
}Output_ResponsePageCitationType
Complete JSON Schema
{
"enum": [
"page_location"
],
"type": "string"
}Output_ResponsePrompt
Complete JSON Schema
Referenced structures: Output_PromptVariableValue
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"variables": {
"additionalProperties": {
"$ref": "#/components/schemas/Output_PromptVariableValue"
},
"type": [
"object",
"null"
]
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
}Output_ResponsePrompt2
Complete JSON Schema
Referenced structures: Output_ResponsePromptVariables
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/response_prompt.py`, `ResponsePrompt`.",
"properties": {
"id": {
"type": "string"
},
"variables": {
"additionalProperties": {
"$ref": "#/components/schemas/Output_ResponsePromptVariables"
},
"type": [
"object",
"null"
]
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"id"
],
"type": "object"
}Output_ResponsePromptCacheOptions
Complete JSON Schema
Referenced structures: Output_PromptCacheTtl, Output_PromptCachingMode
{
"additionalProperties": true,
"properties": {
"comparison_response_id": {
"type": [
"string",
"null"
]
},
"mode": {
"$ref": "#/components/schemas/Output_PromptCachingMode"
},
"ttl": {
"$ref": "#/components/schemas/Output_PromptCacheTtl"
}
},
"required": [
"mode",
"ttl"
],
"type": "object"
}Output_ResponsePromptVariables
Complete JSON Schema
Referenced structures: Output_ResponseInputFile2, Output_ResponseInputImage2, Output_ResponseInputText2
{
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/Output_ResponseInputText2"
},
{
"$ref": "#/components/schemas/Output_ResponseInputImage2"
},
{
"$ref": "#/components/schemas/Output_ResponseInputFile2"
}
],
"description": "Source: `openai/types/responses/response_prompt.py`, `Variables`."
}Output_ResponseQueued
Complete JSON Schema
Referenced structures: Output_GenerateContentResponseBody
{
"additionalProperties": true,
"properties": {
"response": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBody"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"response"
],
"type": "object"
}Output_ResponseRole
Complete JSON Schema
{
"enum": [
"assistant"
],
"type": "string"
}Output_ResponseRole2
Complete JSON Schema
{
"enum": [
"assistant"
],
"type": "string"
}Output_ResponseSearchCitation
Complete JSON Schema
Referenced structures: Output_ResponseSearchCitationType
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"end_block_index": {
"format": "int64",
"type": "integer"
},
"search_result_index": {
"format": "int64",
"type": "integer"
},
"source": {
"type": "string"
},
"start_block_index": {
"format": "int64",
"type": "integer"
},
"title": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseSearchCitationType"
}
},
"required": [
"type",
"cited_text",
"end_block_index",
"search_result_index",
"source",
"start_block_index"
],
"type": "object"
}Output_ResponseSearchCitationType
Complete JSON Schema
{
"enum": [
"search_result_location"
],
"type": "string"
}Output_ResponseServerToolUseBlock
Complete JSON Schema
Referenced structures: Output_Caller2, Output_ResponseServerToolUseBlockType, Output_ServerToolName
{
"additionalProperties": true,
"properties": {
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller2"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input": {
"additionalProperties": true,
"type": "object"
},
"name": {
"$ref": "#/components/schemas/Output_ServerToolName"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseServerToolUseBlockType"
}
},
"required": [
"type",
"id",
"input",
"name"
],
"type": "object"
}Output_ResponseServerToolUseBlockType
Complete JSON Schema
{
"enum": [
"server_tool_use"
],
"type": "string"
}Output_ResponseServiceTier
Complete JSON Schema
{
"enum": [
"standard",
"priority",
"batch"
],
"type": "string"
}Output_ResponseServiceTier2
Complete JSON Schema
{
"enum": [
"auto",
"default",
"flex",
"scale",
"priority",
"fast",
"ultrafast"
],
"type": "string"
}Output_ResponseShellAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"commands": {
"items": {
"type": "string"
},
"type": "array"
},
"max_output_length": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"commands",
"max_output_length",
"timeout_ms"
],
"type": "object"
}Output_ResponseShellCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_ItemStatus, Output_ResponseShellAction, Output_ResponseShellEnvironment, Output_ShellCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Output_ResponseShellAction"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"environment": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseShellEnvironment"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ShellCallType"
}
},
"required": [
"id",
"action",
"call_id",
"environment",
"status",
"type"
],
"type": "object"
}Output_ResponseShellCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_ItemStatus, Output_ResponseShellOutputContent, Output_ShellCallOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"id": {
"type": "string"
},
"max_output_length": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output": {
"items": {
"$ref": "#/components/schemas/Output_ResponseShellOutputContent"
},
"type": "array"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ShellCallOutputType"
}
},
"required": [
"id",
"call_id",
"max_output_length",
"output",
"status",
"type"
],
"type": "object"
}Output_ResponseShellEnvironment
Complete JSON Schema
Referenced structures: Output_ResponseLocalEnvironment, Output_ShellContainerReference
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseLocalEnvironment"
},
{
"$ref": "#/components/schemas/Output_ShellContainerReference"
}
]
}Output_ResponseShellOutputContent
Complete JSON Schema
Referenced structures: Output_ShellOutputOutcome
{
"additionalProperties": true,
"properties": {
"created_by": {
"type": [
"string",
"null"
]
},
"outcome": {
"$ref": "#/components/schemas/Output_ShellOutputOutcome"
},
"stderr": {
"type": "string"
},
"stdout": {
"type": "string"
}
},
"required": [
"outcome",
"stderr",
"stdout"
],
"type": "object"
}Output_ResponseSkill
Complete JSON Schema
Referenced structures: Output_SkillType
{
"additionalProperties": true,
"properties": {
"skill_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_SkillType"
},
"version": {
"type": "string"
}
},
"required": [
"skill_id",
"type",
"version"
],
"type": "object"
}Output_ResponseStatus
Complete JSON Schema
{
"enum": [
"completed",
"failed",
"in_progress",
"cancelled",
"queued",
"incomplete"
],
"type": "string"
}Output_ResponseStreamError
Complete JSON Schema
Referenced structures: Output_ResponseErrorEvent, Output_ResponseNestedErrorEvent
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseErrorEvent"
},
{
"$ref": "#/components/schemas/Output_ResponseNestedErrorEvent"
}
],
"description": "HTTP Responses uses flat errors; the Codex backend also emits nested errors."
}Output_ResponseTextBlock
Complete JSON Schema
Referenced structures: Output_ResponseTextBlockType, Output_ResponseTextCitation
{
"additionalProperties": true,
"properties": {
"citations": {
"items": {
"$ref": "#/components/schemas/Output_ResponseTextCitation"
},
"type": [
"array",
"null"
]
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseTextBlockType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_ResponseTextBlockType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Output_ResponseTextCitation
Complete JSON Schema
Referenced structures: Output_ResponseCharCitation, Output_ResponseContentBlockCitation, Output_ResponsePageCitation, Output_ResponseSearchCitation, Output_ResponseWebCitation
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseCharCitation"
},
{
"$ref": "#/components/schemas/Output_ResponsePageCitation"
},
{
"$ref": "#/components/schemas/Output_ResponseContentBlockCitation"
},
{
"$ref": "#/components/schemas/Output_ResponseWebCitation"
},
{
"$ref": "#/components/schemas/Output_ResponseSearchCitation"
}
]
}Output_ResponseTextDeltaEvent
Complete JSON Schema
Referenced structures: Output_ResponseTextDeltaEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_text_delta_event.py`, `ResponseTextDeltaEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"delta": {
"type": "string"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseTextDeltaEventType"
}
},
"required": [
"content_index",
"delta",
"event_id",
"item_id",
"output_index",
"response_id",
"type"
],
"type": "object"
}Output_ResponseTextDeltaEventType
Complete JSON Schema
{
"enum": [
"response.output_text.delta"
],
"type": "string"
}Output_ResponseTextDoneEvent
Complete JSON Schema
Referenced structures: Output_ResponseTextDoneEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/response_text_done_event.py`, `ResponseTextDoneEvent`.",
"properties": {
"content_index": {
"format": "int64",
"type": "integer"
},
"event_id": {
"type": "string"
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"response_id": {
"type": "string"
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseTextDoneEventType"
}
},
"required": [
"content_index",
"event_id",
"item_id",
"output_index",
"response_id",
"text",
"type"
],
"type": "object"
}Output_ResponseTextDoneEventType
Complete JSON Schema
{
"enum": [
"response.output_text.done"
],
"type": "string"
}Output_ResponseTextEditorCodeExecutionToolResultBlock
Complete JSON Schema
Referenced structures: Output_ResponseTextEditorCodeExecutionToolResultBlockType, Output_ResponseTextEditorResultContent
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_ResponseTextEditorResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseTextEditorCodeExecutionToolResultBlockType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Output_ResponseTextEditorCodeExecutionToolResultBlockType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_tool_result"
],
"type": "string"
}Output_ResponseTextEditorError
Complete JSON Schema
Referenced structures: Output_ResponseTextEditorErrorType, Output_TextEditorErrorCode
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Output_TextEditorErrorCode"
},
"error_message": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseTextEditorErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Output_ResponseTextEditorErrorType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_tool_result_error"
],
"type": "string"
}Output_ResponseTextEditorReplaceResult
Complete JSON Schema
Referenced structures: Output_ResponseTextEditorReplaceResultType
{
"additionalProperties": true,
"properties": {
"lines": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"new_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"new_start": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"old_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"old_start": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseTextEditorReplaceResultType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ResponseTextEditorReplaceResultType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_str_replace_result"
],
"type": "string"
}Output_ResponseTextEditorResultContent
Complete JSON Schema
Referenced structures: Output_ResponseTextEditorError, Output_ResponseTextEditorReplaceResult, Output_ResponseTextEditorViewResult, Output_TextEditorCreateResult
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseTextEditorError"
},
{
"$ref": "#/components/schemas/Output_ResponseTextEditorViewResult"
},
{
"$ref": "#/components/schemas/Output_TextEditorCreateResult"
},
{
"$ref": "#/components/schemas/Output_ResponseTextEditorReplaceResult"
}
]
}Output_ResponseTextEditorViewResult
Complete JSON Schema
Referenced structures: Output_ResponseTextEditorViewResultType, Output_TextEditorFileType
{
"additionalProperties": true,
"properties": {
"content": {
"type": "string"
},
"file_type": {
"$ref": "#/components/schemas/Output_TextEditorFileType"
},
"num_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"start_line": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"total_lines": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseTextEditorViewResultType"
}
},
"required": [
"type",
"content",
"file_type"
],
"type": "object"
}Output_ResponseTextEditorViewResultType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_view_result"
],
"type": "string"
}Output_ResponseToolReferenceBlock
Complete JSON Schema
Referenced structures: Output_ResponseToolReferenceBlockType
{
"additionalProperties": true,
"properties": {
"tool_name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseToolReferenceBlockType"
}
},
"required": [
"type",
"tool_name"
],
"type": "object"
}Output_ResponseToolReferenceBlockType
Complete JSON Schema
{
"enum": [
"tool_reference"
],
"type": "string"
}Output_ResponseToolSearchCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_ItemStatus, Output_ToolExecution, Output_ToolSearchCallType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": true,
"call_id": {
"type": [
"string",
"null"
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"execution": {
"$ref": "#/components/schemas/Output_ToolExecution"
},
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"type": {
"$ref": "#/components/schemas/Output_ToolSearchCallType"
}
},
"required": [
"id",
"arguments",
"call_id",
"execution",
"status",
"type"
],
"type": "object"
}Output_ResponseToolSearchError
Complete JSON Schema
Referenced structures: Output_ResponseToolSearchErrorType, Output_ToolSearchErrorCode
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Output_ToolSearchErrorCode"
},
"error_message": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseToolSearchErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Output_ResponseToolSearchErrorType
Complete JSON Schema
{
"enum": [
"tool_search_tool_result_error"
],
"type": "string"
}Output_ResponseToolSearchOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ItemStatus, Output_Tool, Output_ToolExecution, Output_ToolSearchOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": [
"string",
"null"
]
},
"created_by": {
"type": [
"string",
"null"
]
},
"execution": {
"$ref": "#/components/schemas/Output_ToolExecution"
},
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Output_ItemStatus"
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_Tool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_ToolSearchOutputType"
}
},
"required": [
"id",
"call_id",
"execution",
"status",
"tools",
"type"
],
"type": "object"
}Output_ResponseToolSearchResultContent
Complete JSON Schema
Referenced structures: Output_ResponseToolSearchError, Output_ResponseToolSearchResults
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseToolSearchError"
},
{
"$ref": "#/components/schemas/Output_ResponseToolSearchResults"
}
]
}Output_ResponseToolSearchResults
Complete JSON Schema
Referenced structures: Output_ResponseToolReferenceBlock, Output_ResponseToolSearchResultsType
{
"additionalProperties": true,
"properties": {
"tool_references": {
"items": {
"$ref": "#/components/schemas/Output_ResponseToolReferenceBlock"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseToolSearchResultsType"
}
},
"required": [
"type",
"tool_references"
],
"type": "object"
}Output_ResponseToolSearchResultsType
Complete JSON Schema
{
"enum": [
"tool_search_tool_search_result"
],
"type": "string"
}Output_ResponseToolSearchToolResultBlock
Complete JSON Schema
Referenced structures: Output_ResponseToolSearchResultContent, Output_ResponseToolSearchToolResultBlockType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_ResponseToolSearchResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseToolSearchToolResultBlockType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Output_ResponseToolSearchToolResultBlockType
Complete JSON Schema
{
"enum": [
"tool_search_tool_result"
],
"type": "string"
}Output_ResponseToolUseBlock
Complete JSON Schema
Referenced structures: Output_Caller2, Output_ResponseToolUseBlockType
{
"additionalProperties": true,
"properties": {
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller2"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input": {
"additionalProperties": true,
"type": "object"
},
"name": {
"type": "string"
},
"toolset_name": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseToolUseBlockType"
}
},
"required": [
"type",
"id",
"input",
"name"
],
"type": "object"
}Output_ResponseToolUseBlockType
Complete JSON Schema
{
"enum": [
"tool_use"
],
"type": "string"
}Output_ResponseUsage
Complete JSON Schema
Referenced structures: Output_ResponseInputTokensDetails, Output_ResponseOutputTokensDetails
{
"additionalProperties": true,
"properties": {
"input_tokens": {
"format": "int64",
"type": "integer"
},
"input_tokens_details": {
"$ref": "#/components/schemas/Output_ResponseInputTokensDetails"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens_details": {
"$ref": "#/components/schemas/Output_ResponseOutputTokensDetails"
},
"total_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"input_tokens",
"input_tokens_details",
"output_tokens",
"output_tokens_details",
"total_tokens"
],
"type": "object"
}Output_ResponseWebCitation
Complete JSON Schema
Referenced structures: Output_ResponseWebCitationType
{
"additionalProperties": true,
"properties": {
"cited_text": {
"type": "string"
},
"encrypted_index": {
"type": "string"
},
"title": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseWebCitationType"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"cited_text",
"encrypted_index",
"url"
],
"type": "object"
}Output_ResponseWebCitationType
Complete JSON Schema
{
"enum": [
"web_search_result_location"
],
"type": "string"
}Output_ResponseWebFetchResult
Complete JSON Schema
Referenced structures: Output_ResponseDocumentBlock, Output_ResponseWebFetchResultType
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_ResponseDocumentBlock"
},
"retrieved_at": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ResponseWebFetchResultType"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"content",
"url"
],
"type": "object"
}Output_ResponseWebFetchResultContent
Complete JSON Schema
Referenced structures: Output_ResponseWebFetchResult, Output_WebFetchError
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_WebFetchError"
},
{
"$ref": "#/components/schemas/Output_ResponseWebFetchResult"
}
]
}Output_ResponseWebFetchResultType
Complete JSON Schema
{
"enum": [
"web_fetch_result"
],
"type": "string"
}Output_ResponseWebFetchToolResultBlock
Complete JSON Schema
Referenced structures: Output_Caller2, Output_ResponseWebFetchResultContent, Output_ResponseWebFetchToolResultBlockType
{
"additionalProperties": true,
"properties": {
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller2"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Output_ResponseWebFetchResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseWebFetchToolResultBlockType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Output_ResponseWebFetchToolResultBlockType
Complete JSON Schema
{
"enum": [
"web_fetch_tool_result"
],
"type": "string"
}Output_ResponseWebSearchResult
Complete JSON Schema
Referenced structures: Output_ResponseWebSearchResultType
{
"additionalProperties": true,
"properties": {
"encrypted_content": {
"type": "string"
},
"page_age": {
"type": [
"string",
"null"
]
},
"title": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseWebSearchResultType"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"encrypted_content",
"title",
"url"
],
"type": "object"
}Output_ResponseWebSearchResultContent
Complete JSON Schema
Referenced structures: Output_ResponseWebSearchResult, Output_WebSearchError
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_WebSearchError"
},
{
"items": {
"$ref": "#/components/schemas/Output_ResponseWebSearchResult"
},
"type": "array"
}
]
}Output_ResponseWebSearchResultType
Complete JSON Schema
{
"enum": [
"web_search_result"
],
"type": "string"
}Output_ResponseWebSearchToolResultBlock
Complete JSON Schema
Referenced structures: Output_Caller2, Output_ResponseWebSearchResultContent, Output_ResponseWebSearchToolResultBlockType
{
"additionalProperties": true,
"properties": {
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller2"
},
{
"type": "null"
}
]
},
"content": {
"$ref": "#/components/schemas/Output_ResponseWebSearchResultContent"
},
"tool_use_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ResponseWebSearchToolResultBlockType"
}
},
"required": [
"type",
"content",
"tool_use_id"
],
"type": "object"
}Output_ResponseWebSearchToolResultBlockType
Complete JSON Schema
{
"enum": [
"web_search_tool_result"
],
"type": "string"
}Output_RetrievalMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"googleSearchDynamicRetrievalScore": {
"format": "double",
"type": [
"number",
"null"
]
}
},
"type": "object"
}Output_RetrievedContext
Complete JSON Schema
Referenced structures: Output_CustomMetadata
{
"additionalProperties": true,
"properties": {
"customMetadata": {
"items": {
"$ref": "#/components/schemas/Output_CustomMetadata"
},
"type": [
"array",
"null"
]
},
"fileSearchStore": {
"type": [
"string",
"null"
]
},
"mediaId": {
"type": [
"string",
"null"
]
},
"pageNumber": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"uri": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ReviewSnippet
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"googleMapsUri": {
"type": [
"string",
"null"
]
},
"reviewId": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_RewriteRuleDto
Complete JSON Schema
{
"description": "One ordered replacement. Every write compiles the rule with core's own\ncompiler first, so a rule that would be skipped at assembly is refused\nhere instead of silently doing nothing.",
"properties": {
"action": {
"default": "replace",
"type": "string"
},
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"filterBody": {
"default": null
},
"filterEventPattern": {
"type": [
"string",
"null"
]
},
"filterHeader": {
"default": null
},
"filterHeaderPattern": {
"type": [
"string",
"null"
]
},
"filterModelPattern": {
"type": [
"string",
"null"
]
},
"filterOperationKeys": {
"description": "JSON array of `{\"operation\": …, \"dialect\": …}`."
},
"id": {
"type": "string"
},
"paths": {
"description": "JSON array of dot paths; body target only."
},
"pattern": {
"type": "string"
},
"phase": {
"description": "`request`, `response` or `both`.",
"type": "string"
},
"replacement": {
"type": "string"
},
"ruleSetId": {
"type": "string"
},
"sortOrder": {
"format": "int64",
"type": "integer"
},
"target": {
"description": "`body`, `header` or `query`.",
"type": "string"
},
"targetName": {
"type": [
"string",
"null"
]
},
"updatedAtMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"ruleSetId",
"phase",
"action",
"target",
"targetName",
"paths",
"pattern",
"replacement",
"filterOperationKeys",
"filterModelPattern",
"filterHeaderPattern",
"filterEventPattern",
"filterBody",
"filterHeader",
"sortOrder",
"enabled",
"createdAtMs",
"updatedAtMs"
],
"type": "object"
}Output_RewriteRuleWrite
Complete JSON Schema
{
"properties": {
"action": {
"default": null,
"type": [
"string",
"null"
]
},
"enabled": {
"default": null,
"type": [
"boolean",
"null"
]
},
"filterBody": {
"default": null
},
"filterEventPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterHeader": {
"default": null
},
"filterHeaderPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterModelPattern": {
"default": null,
"type": [
"string",
"null"
]
},
"filterOperationKeys": {
"default": null
},
"id": {
"default": null,
"type": [
"string",
"null"
]
},
"paths": {
"default": null
},
"pattern": {
"type": "string"
},
"phase": {
"default": null,
"type": [
"string",
"null"
]
},
"replacement": {
"type": "string"
},
"ruleSetId": {
"default": null,
"description": "Ignored by `replace_rules`, which owns the set it is replacing.",
"type": [
"string",
"null"
]
},
"sortOrder": {
"default": null,
"format": "int64",
"type": [
"integer",
"null"
]
},
"target": {
"default": null,
"type": [
"string",
"null"
]
},
"targetName": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"ruleSetId",
"phase",
"action",
"target",
"targetName",
"paths",
"pattern",
"replacement",
"filterOperationKeys",
"filterModelPattern",
"filterHeaderPattern",
"filterEventPattern",
"filterBody",
"filterHeader",
"sortOrder",
"enabled"
],
"type": "object"
}Output_RouteDto
Complete JSON Schema
{
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"maxAttempts": {
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"name": {
"description": "The exact model name clients send in requests.",
"type": "string"
},
"sessionAffinity": {
"default": false,
"type": "boolean"
},
"strategy": {
"description": "`round_robin`, `weighted` or `failover`.",
"type": "string"
}
},
"required": [
"id",
"name",
"strategy",
"sessionAffinity",
"maxAttempts",
"enabled"
],
"type": "object"
}Output_RouteMemberDto
Complete JSON Schema
{
"properties": {
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"providerId": {
"type": "string"
},
"routeId": {
"type": "string"
},
"tier": {
"description": "Lower tiers are preferred; later tiers are the fallback.",
"format": "uint32",
"minimum": 0,
"type": "integer"
},
"upstreamModel": {
"description": "The upstream model this member sends, not a catalog reference.",
"type": "string"
},
"weight": {
"description": "Positive relative weight within a tier.",
"format": "uint32",
"minimum": 0,
"type": "integer"
}
},
"required": [
"id",
"routeId",
"providerId",
"upstreamModel",
"tier",
"weight",
"enabled"
],
"type": "object"
}Output_RoutingMappingDto
Complete JSON Schema
Referenced structures: Output_RoutingTargetDto
{
"properties": {
"implementation": {
"type": "string"
},
"target": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RoutingTargetDto"
},
{
"type": "null"
}
]
}
},
"required": [
"implementation",
"target"
],
"type": "object"
}Output_RoutingTargetDto
Complete JSON Schema
{
"description": "One exact operation/protocol key accepted by a conversion driver.",
"properties": {
"dialect": {
"type": "string"
},
"operation": {
"type": "string"
}
},
"required": [
"operation",
"dialect"
],
"type": "object"
}Output_RulePresetCategory
Complete JSON Schema
{
"oneOf": [
{
"const": "application",
"description": "Rewrites that hide one client application's identity from the upstream.",
"type": "string"
}
]
}Output_RulePresetDto
Complete JSON Schema
Referenced structures: Output_RewriteRuleWrite, Output_RulePresetCategory
{
"description": "A named set of rewrite rules. `rules` is what `apply_rule_preset` writes;\nit is the ordinary write shape, so a caller may edit the list first and\nsend it through `rewrite().replace_rules` itself.",
"properties": {
"category": {
"$ref": "#/components/schemas/Output_RulePresetCategory"
},
"description": {
"description": "A stable machine tag, `gproxy:preset:{id}:v1`, so a console can tell\nwhich preset a rule set came from.",
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"rules": {
"items": {
"$ref": "#/components/schemas/Output_RewriteRuleWrite"
},
"type": "array"
}
},
"required": [
"id",
"name",
"description",
"category",
"rules"
],
"type": "object"
}Output_RuleSetDto
Complete JSON Schema
{
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"description": {
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"providerCount": {
"description": "Number of provider attachments, populated by list/get.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"updatedAtMs": {
"format": "int64",
"type": "integer"
}
},
"required": [
"id",
"name",
"description",
"enabled",
"createdAtMs",
"updatedAtMs"
],
"type": "object"
}Output_SafetyRating
Complete JSON Schema
Referenced structures: Output_HarmCategory, Output_HarmProbability
{
"additionalProperties": true,
"properties": {
"blocked": {
"type": [
"boolean",
"null"
]
},
"category": {
"$ref": "#/components/schemas/Output_HarmCategory"
},
"probability": {
"$ref": "#/components/schemas/Output_HarmProbability"
}
},
"required": [
"category",
"probability"
],
"type": "object"
}Output_Scheduling
Complete JSON Schema
{
"enum": [
"SCHEDULING_UNSPECIFIED",
"SILENT",
"WHEN_IDLE",
"INTERRUPT"
],
"type": "string"
}Output_ScreenshotAction
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_ScrollAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"keys": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"scroll_x": {
"format": "int64",
"type": "integer"
},
"scroll_y": {
"format": "int64",
"type": "integer"
},
"x": {
"format": "int64",
"type": "integer"
},
"y": {
"format": "int64",
"type": "integer"
}
},
"required": [
"scroll_x",
"scroll_y",
"x",
"y"
],
"type": "object"
}Output_SealedSecretDto
Complete JSON Schema
{
"description": "A sealed secret as it travels: the envelope's own codec, and its bytes in\nstandard base64. Nothing here is plaintext, and nothing here can be opened\nwithout the key the source sealed it with.",
"properties": {
"bytes": {
"type": "string"
},
"codec": {
"description": "`plaintext`, `aes-gcm`, or `unknown` for an envelope this build does\nnot recognize. Carried so an importer can refuse early rather than\nafter decrypting nothing.",
"type": "string"
}
},
"required": [
"codec",
"bytes"
],
"type": "object"
}Output_SearchContentType
Complete JSON Schema
{
"enum": [
"text",
"image"
],
"type": "string"
}Output_SearchContextSize
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
}Output_SearchEntryPoint
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"renderedContent": {
"type": [
"string",
"null"
]
},
"sdkBlob": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_Segment
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endIndex": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"partIndex": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"startIndex": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_SemanticRetrieverChunk
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"chunk": {
"type": [
"string",
"null"
]
},
"source": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ServerCaller
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"tool_id": {
"type": "string"
}
},
"required": [
"tool_id"
],
"type": "object"
}Output_ServerCaller20260120
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"tool_id": {
"type": "string"
}
},
"required": [
"tool_id"
],
"type": "object"
}Output_ServerMessage
Complete JSON Schema
Referenced structures: Output_InjectionEvent, Output_InterruptEvent, Output_SteeringEvent, Output_StreamEvent
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_InterruptEvent"
},
{
"$ref": "#/components/schemas/Output_InjectionEvent"
},
{
"$ref": "#/components/schemas/Output_SteeringEvent"
},
{
"$ref": "#/components/schemas/Output_StreamEvent"
}
],
"description": "Generation and steering have distinct lifecycles on the same connection.",
"properties": {
"stream_id": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ServerToolName
Complete JSON Schema
{
"enum": [
"advisor",
"web_search",
"web_fetch",
"code_execution",
"bash_code_execution",
"text_editor_code_execution",
"tool_search_tool_regex",
"tool_search_tool_bm25"
],
"type": "string"
}Output_ServerToolUsage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"web_fetch_requests": {
"format": "int64",
"type": "integer"
},
"web_search_requests": {
"format": "int64",
"type": "integer"
}
},
"required": [
"web_fetch_requests",
"web_search_requests"
],
"type": "object"
}Output_ServerToolsCapability
Complete JSON Schema
Referenced structures: Output_CapabilitySupport
{
"additionalProperties": true,
"description": "Server tool availability is separate from programmatic tool calling\n(`ModelCapabilities::code_execution`).",
"properties": {
"code_execution": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"supported": {
"type": "boolean"
},
"web_search": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
}
},
"required": [
"supported",
"web_search",
"code_execution"
],
"type": "object"
}Output_ServiceTier
Complete JSON Schema
{
"enum": [
"auto",
"default",
"flex",
"scale",
"priority",
"fast",
"ultrafast"
],
"type": "string"
}Output_ServiceTier2
Complete JSON Schema
{
"enum": [
"unspecified",
"standard",
"flex",
"priority"
],
"type": "string"
}Output_SessionCreatedEvent
Complete JSON Schema
Referenced structures: Output_SessionCreatedEventSession, Output_SessionCreatedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/session_created_event.py`, `SessionCreatedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"session": {
"$ref": "#/components/schemas/Output_SessionCreatedEventSession"
},
"type": {
"$ref": "#/components/schemas/Output_SessionCreatedEventType"
}
},
"required": [
"event_id",
"session",
"type"
],
"type": "object"
}Output_SessionCreatedEventSession
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateRequest, Output_RealtimeTranscriptionSessionCreateRequest
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateRequest"
},
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateRequest"
}
],
"description": "Source: `openai/types/realtime/session_created_event.py`, `Session`."
}Output_SessionCreatedEventType
Complete JSON Schema
{
"enum": [
"session.created"
],
"type": "string"
}Output_SessionResumptionUpdate
Complete JSON Schema
Referenced structures: Output_LiveInt64
{
"additionalProperties": true,
"properties": {
"lastConsumedClientMessageIndex": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_LiveInt64"
},
{
"type": "null"
}
]
},
"newHandle": {
"type": [
"string",
"null"
]
},
"resumable": {
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}Output_SessionStatus
Complete JSON Schema
{
"properties": {
"apiKeyId": {
"type": [
"string",
"null"
]
},
"userId": {
"type": "string"
},
"userRole": {
"type": "string"
}
},
"required": [
"userId",
"userRole",
"apiKeyId"
],
"type": "object"
}Output_SessionUpdatedEvent
Complete JSON Schema
Referenced structures: Output_SessionUpdatedEventSession, Output_SessionUpdatedEventType
{
"additionalProperties": true,
"description": "Source: `openai/types/realtime/session_updated_event.py`, `SessionUpdatedEvent`.",
"properties": {
"event_id": {
"type": "string"
},
"session": {
"$ref": "#/components/schemas/Output_SessionUpdatedEventSession"
},
"type": {
"$ref": "#/components/schemas/Output_SessionUpdatedEventType"
}
},
"required": [
"event_id",
"session",
"type"
],
"type": "object"
}Output_SessionUpdatedEventSession
Complete JSON Schema
Referenced structures: Output_RealtimeSessionCreateRequest, Output_RealtimeTranscriptionSessionCreateRequest
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_RealtimeSessionCreateRequest"
},
{
"$ref": "#/components/schemas/Output_RealtimeTranscriptionSessionCreateRequest"
}
],
"description": "Source: `openai/types/realtime/session_updated_event.py`, `Session`."
}Output_SessionUpdatedEventType
Complete JSON Schema
{
"enum": [
"session.updated"
],
"type": "string"
}Output_SettingsDto
Complete JSON Schema
Referenced structures: Output_InstanceSettingsDto, Output_LoggingSettingsDto
{
"properties": {
"instance": {
"$ref": "#/components/schemas/Output_InstanceSettingsDto"
},
"logging": {
"$ref": "#/components/schemas/Output_LoggingSettingsDto"
}
},
"required": [
"instance",
"logging"
],
"type": "object"
}Output_ShellAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"commands": {
"items": {
"type": "string"
},
"type": "array"
},
"max_output_length": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"timeout_ms": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"required": [
"commands"
],
"type": "object"
}Output_ShellCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_ItemStatus, Output_ShellAction, Output_ShellCallEnvironment, Output_ShellCallType
{
"additionalProperties": true,
"properties": {
"action": {
"$ref": "#/components/schemas/Output_ShellAction"
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"environment": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ShellCallEnvironment"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ShellCallType"
}
},
"required": [
"type",
"call_id",
"action"
],
"type": "object"
}Output_ShellCallEnvironment
Complete JSON Schema
Referenced structures: Output_ShellContainerReference, Output_ShellLocalEnvironment
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ShellLocalEnvironment"
},
{
"$ref": "#/components/schemas/Output_ShellContainerReference"
}
]
}Output_ShellCallOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_Caller, Output_ItemStatus, Output_ShellCallOutputType, Output_ShellOutputContent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": "string"
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Caller"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"max_output_length": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"output": {
"items": {
"$ref": "#/components/schemas/Output_ShellOutputContent"
},
"type": "array"
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ShellCallOutputType"
}
},
"required": [
"type",
"call_id",
"output"
],
"type": "object"
}Output_ShellCallOutputType
Complete JSON Schema
{
"enum": [
"shell_call_output"
],
"type": "string"
}Output_ShellCallType
Complete JSON Schema
{
"enum": [
"shell_call"
],
"type": "string"
}Output_ShellContainerAuto
Complete JSON Schema
Referenced structures: Output_ContainerNetworkPolicy, Output_MemoryLimit, Output_ShellContainerAutoType, Output_ShellSkill
{
"additionalProperties": true,
"properties": {
"file_ids": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"memory_limit": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MemoryLimit"
},
{
"type": "null"
}
]
},
"network_policy": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ContainerNetworkPolicy"
},
{
"type": "null"
}
]
},
"skills": {
"items": {
"$ref": "#/components/schemas/Output_ShellSkill"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ShellContainerAutoType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ShellContainerAutoType
Complete JSON Schema
{
"enum": [
"container_auto"
],
"type": "string"
}Output_ShellContainerReference
Complete JSON Schema
Referenced structures: Output_ShellReferenceType
{
"additionalProperties": true,
"properties": {
"container_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ShellReferenceType"
}
},
"required": [
"type",
"container_id"
],
"type": "object"
}Output_ShellEnvironment
Complete JSON Schema
Referenced structures: Output_ShellContainerAuto, Output_ShellContainerReference, Output_ShellLocalEnvironment
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ShellContainerAuto"
},
{
"$ref": "#/components/schemas/Output_ShellLocalEnvironment"
},
{
"$ref": "#/components/schemas/Output_ShellContainerReference"
}
]
}Output_ShellExit
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"exit_code": {
"format": "int64",
"type": "integer"
}
},
"required": [
"exit_code"
],
"type": "object"
}Output_ShellLocalEnvironment
Complete JSON Schema
Referenced structures: Output_LocalSkill, Output_ShellLocalType
{
"additionalProperties": true,
"properties": {
"skills": {
"items": {
"$ref": "#/components/schemas/Output_LocalSkill"
},
"type": [
"array",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_ShellLocalType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ShellLocalType
Complete JSON Schema
{
"enum": [
"local"
],
"type": "string"
}Output_ShellOutputContent
Complete JSON Schema
Referenced structures: Output_ShellOutputOutcome
{
"additionalProperties": true,
"properties": {
"outcome": {
"$ref": "#/components/schemas/Output_ShellOutputOutcome"
},
"stderr": {
"type": "string"
},
"stdout": {
"type": "string"
}
},
"required": [
"stdout",
"stderr",
"outcome"
],
"type": "object"
}Output_ShellOutputOutcome
Complete JSON Schema
Referenced structures: Output_ShellExit, Output_ShellTimeout
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_ShellTimeout",
"properties": {
"type": {
"const": "timeout",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ShellExit",
"properties": {
"type": {
"const": "exit",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ShellReferenceType
Complete JSON Schema
{
"enum": [
"container_reference"
],
"type": "string"
}Output_ShellSkill
Complete JSON Schema
Referenced structures: Output_InlineSkill, Output_SkillReference
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_SkillReference"
},
{
"$ref": "#/components/schemas/Output_InlineSkill"
}
]
}Output_ShellTimeout
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_ShellTool
Complete JSON Schema
Referenced structures: Output_AllowedCaller, Output_ShellEnvironment
{
"additionalProperties": true,
"properties": {
"allowed_callers": {
"items": {
"$ref": "#/components/schemas/Output_AllowedCaller"
},
"type": [
"array",
"null"
]
},
"environment": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ShellEnvironment"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_SignatureDelta
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"signature": {
"type": "string"
}
},
"required": [
"signature"
],
"type": "object"
}Output_SkillReference
Complete JSON Schema
Referenced structures: Output_SkillReferenceType
{
"additionalProperties": true,
"properties": {
"skill_id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_SkillReferenceType"
},
"version": {
"type": [
"string",
"null"
]
}
},
"required": [
"skill_id",
"type"
],
"type": "object"
}Output_SkillReferenceType
Complete JSON Schema
{
"enum": [
"skill_reference"
],
"type": "string"
}Output_SkillType
Complete JSON Schema
{
"enum": [
"anthropic",
"custom"
],
"type": "string"
}Output_SpeechAudioDelta
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"audio": {
"type": "string"
}
},
"required": [
"audio"
],
"type": "object"
}Output_SpeechAudioDone
Complete JSON Schema
Referenced structures: Output_SpeechUsage
{
"additionalProperties": true,
"properties": {
"usage": {
"$ref": "#/components/schemas/Output_SpeechUsage"
}
},
"required": [
"usage"
],
"type": "object"
}Output_SpeechAudioEvent
Complete JSON Schema
Referenced structures: Output_SpeechAudioDelta, Output_SpeechAudioDone
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_SpeechAudioDelta",
"properties": {
"type": {
"const": "speech.audio.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_SpeechAudioDone",
"properties": {
"type": {
"const": "speech.audio.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_SpeechMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"speaker": {
"type": [
"string",
"null"
]
},
"style": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_SpeechState
Complete JSON Schema
{
"anyOf": [
{
"type": "string"
},
{
"format": "int32",
"type": "integer"
}
],
"description": "ai.google.dev/api/live exposes deprecated speechState but provides no value\ntable; current public proto/SDK omit its declaration. Preserve the named enum\nrepresentation without inventing constants. ProtoJSON enums can be names/ints."
}Output_SpeechUsage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"input_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"total_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"input_tokens",
"output_tokens",
"total_tokens"
],
"type": "object"
}Output_Speed
Complete JSON Schema
{
"enum": [
"standard",
"fast"
],
"type": "string"
}Output_Status
Complete JSON Schema
Referenced structures: Output_StatusDetail
{
"additionalProperties": true,
"properties": {
"code": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"details": {
"items": {
"$ref": "#/components/schemas/Output_StatusDetail"
},
"type": [
"array",
"null"
]
},
"message": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_StatusDetail
Complete JSON Schema
{
"additionalProperties": true,
"description": "google.rpc.Status.details is a list of protobuf Any objects. Discovery\nexplicitly permits arbitrary payload properties; @type identifies their schema.",
"properties": {
"@type": {
"type": "string"
}
},
"required": [
"@type"
],
"type": "object"
}Output_SteerAccepted
Complete JSON Schema
Referenced structures: Output_SteeringReference
{
"additionalProperties": true,
"properties": {
"sequence_number": {
"format": "int64",
"type": "integer"
},
"steer": {
"$ref": "#/components/schemas/Output_SteeringReference"
}
},
"required": [
"sequence_number",
"steer"
],
"type": "object"
}Output_SteerError
Complete JSON Schema
Referenced structures: Output_SteerErrorType
{
"additionalProperties": true,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_SteerErrorType"
}
},
"required": [
"code",
"message",
"type"
],
"type": "object"
}Output_SteerErrorType
Complete JSON Schema
{
"enum": [
"invalid_request_error"
],
"type": "string"
}Output_SteerFailed
Complete JSON Schema
Referenced structures: Output_FailedSteeringSubmission, Output_SteerError
{
"additionalProperties": true,
"properties": {
"error": {
"$ref": "#/components/schemas/Output_SteerError"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"steer": {
"$ref": "#/components/schemas/Output_FailedSteeringSubmission"
}
},
"required": [
"sequence_number",
"steer",
"error"
],
"type": "object"
}Output_SteerInput
Complete JSON Schema
Referenced structures: Output_SteerMessage
{
"anyOf": [
{
"type": "string"
},
{
"items": {
"$ref": "#/components/schemas/Output_SteerMessage"
},
"type": "array"
}
]
}Output_SteerMessage
Complete JSON Schema
Referenced structures: Output_MessageContent, Output_MessageType, Output_SteerRole
{
"additionalProperties": true,
"properties": {
"content": {
"$ref": "#/components/schemas/Output_MessageContent"
},
"role": {
"$ref": "#/components/schemas/Output_SteerRole"
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MessageType"
},
{
"type": "null"
}
]
}
},
"required": [
"role",
"content"
],
"type": "object"
}Output_SteerPending
Complete JSON Schema
Referenced structures: Output_RequiredSteeringInput, Output_SteeringReference
{
"additionalProperties": true,
"properties": {
"reason": {
"type": "string"
},
"required_input": {
"items": {
"$ref": "#/components/schemas/Output_RequiredSteeringInput"
},
"type": "array"
},
"sequence_number": {
"format": "int64",
"type": "integer"
},
"steer": {
"$ref": "#/components/schemas/Output_SteeringReference"
}
},
"required": [
"sequence_number",
"steer",
"reason",
"required_input"
],
"type": "object"
}Output_SteerRole
Complete JSON Schema
{
"enum": [
"user"
],
"type": "string"
}Output_SteeringEvent
Complete JSON Schema
Referenced structures: Output_SteerAccepted, Output_SteerFailed, Output_SteerPending
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_SteerAccepted",
"properties": {
"type": {
"const": "response.steer.accepted",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_SteerPending",
"properties": {
"type": {
"const": "response.steer.pending",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_SteerFailed",
"properties": {
"type": {
"const": "response.steer.failed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_SteeringReference
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"previous_response_id": {
"type": "string"
}
},
"required": [
"id",
"previous_response_id"
],
"type": "object"
}Output_SteeringToolSearchExecution
Complete JSON Schema
{
"enum": [
"client"
],
"type": "string"
}Output_StopReason
Complete JSON Schema
{
"enum": [
"end_turn",
"max_tokens",
"stop_sequence",
"tool_use",
"pause_turn",
"compaction",
"refusal",
"model_context_window_exceeded"
],
"type": "string"
}Output_StreamChoice
Complete JSON Schema
Referenced structures: Output_ChunkLogprobs, Output_Delta, Output_FinishReason2
{
"additionalProperties": true,
"properties": {
"delta": {
"$ref": "#/components/schemas/Output_Delta"
},
"finish_reason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FinishReason2"
},
{
"type": "null"
}
]
},
"index": {
"format": "int64",
"type": "integer"
},
"logprobs": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ChunkLogprobs"
},
{
"type": "null"
}
]
}
},
"required": [
"index",
"delta"
],
"type": "object"
}Output_StreamError
Complete JSON Schema
Referenced structures: Output_StreamErrorType
{
"additionalProperties": true,
"properties": {
"message": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_StreamErrorType"
}
},
"required": [
"type",
"message"
],
"type": "object"
}Output_StreamErrorType
Complete JSON Schema
{
"enum": [
"api_error",
"authentication_error",
"billing_error",
"invalid_request_error",
"not_found_error",
"overloaded_error",
"permission_error",
"rate_limit_error",
"timeout_error",
"conflict_error",
"request_too_large"
],
"type": "string"
}Output_StreamEvent
Complete JSON Schema
Referenced structures: Output_AudioDelta, Output_AudioDone, Output_AudioTranscriptDelta, Output_AudioTranscriptDone, Output_CodeInterpreterCodeDelta, Output_CodeInterpreterCodeDone, Output_CodeInterpreterEvent, Output_ContentPartEvent, Output_CustomToolInputDelta, Output_CustomToolInputDone, Output_FunctionCallArgumentsDelta, Output_FunctionCallArgumentsDone, Output_ImageCall, Output_ImagePartial, Output_McpArgumentsDelta, Output_McpArgumentsDone, Output_McpCallEvent, Output_McpListToolsEvent, Output_OutputItemEvent, Output_OutputTextAnnotationAdded, Output_OutputTextDelta, Output_OutputTextDone, Output_ReasoningSummaryPartAddedEvent, Output_ReasoningSummaryPartDoneEvent, Output_ReasoningSummaryTextDelta, Output_ReasoningSummaryTextDone, Output_ReasoningTextDelta, Output_ReasoningTextDone, Output_RefusalDelta, Output_RefusalDone, Output_ResponseCompleted, Output_ResponseCreated, Output_ResponseFailed, Output_ResponseInProgress, Output_ResponseIncomplete, Output_ResponseMetadata, Output_ResponseQueued, Output_ResponseStreamError, Output_ToolCallEvent
{
"description": "Typed payloads for the HTTP Responses SSE stream. SSE framing and `[DONE]`\nhandling remain transport concerns; this enum only represents JSON data.",
"oneOf": [
{
"description": "Undocumented upstream heartbeat; converted to Claude ping or otherwise ignored.",
"properties": {
"type": {
"const": "keepalive",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseMetadata",
"description": "Out-of-band response metadata emitted by the Codex Responses backend.",
"properties": {
"type": {
"const": "response.metadata",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseCreated",
"properties": {
"type": {
"const": "response.created",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseQueued",
"properties": {
"type": {
"const": "response.queued",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseInProgress",
"properties": {
"type": {
"const": "response.in_progress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseCompleted",
"properties": {
"type": {
"const": "response.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseFailed",
"properties": {
"type": {
"const": "response.failed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseIncomplete",
"properties": {
"type": {
"const": "response.incomplete",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_OutputItemEvent",
"properties": {
"type": {
"const": "response.output_item.added",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_OutputItemEvent",
"properties": {
"type": {
"const": "response.output_item.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ContentPartEvent",
"properties": {
"type": {
"const": "response.content_part.added",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ContentPartEvent",
"properties": {
"type": {
"const": "response.content_part.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_OutputTextDelta",
"properties": {
"type": {
"const": "response.output_text.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_OutputTextDone",
"properties": {
"type": {
"const": "response.output_text.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_OutputTextAnnotationAdded",
"properties": {
"type": {
"const": "response.output_text.annotation.added",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_RefusalDelta",
"properties": {
"type": {
"const": "response.refusal.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_RefusalDone",
"properties": {
"type": {
"const": "response.refusal.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ReasoningTextDelta",
"properties": {
"type": {
"const": "response.reasoning_text.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ReasoningTextDone",
"properties": {
"type": {
"const": "response.reasoning_text.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ReasoningSummaryPartAddedEvent",
"properties": {
"type": {
"const": "response.reasoning_summary_part.added",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ReasoningSummaryPartDoneEvent",
"properties": {
"type": {
"const": "response.reasoning_summary_part.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ReasoningSummaryTextDelta",
"properties": {
"type": {
"const": "response.reasoning_summary_text.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ReasoningSummaryTextDone",
"properties": {
"type": {
"const": "response.reasoning_summary_text.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_FunctionCallArgumentsDelta",
"properties": {
"type": {
"const": "response.function_call_arguments.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_FunctionCallArgumentsDone",
"properties": {
"type": {
"const": "response.function_call_arguments.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CustomToolInputDelta",
"properties": {
"type": {
"const": "response.custom_tool_call_input.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CustomToolInputDone",
"properties": {
"type": {
"const": "response.custom_tool_call_input.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterCodeDelta",
"properties": {
"type": {
"const": "response.code_interpreter_call_code.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterCodeDone",
"properties": {
"type": {
"const": "response.code_interpreter_call_code.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_AudioDelta",
"properties": {
"type": {
"const": "response.audio.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_AudioDone",
"properties": {
"type": {
"const": "response.audio.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_AudioTranscriptDelta",
"properties": {
"type": {
"const": "response.audio.transcript.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_AudioTranscriptDone",
"properties": {
"type": {
"const": "response.audio.transcript.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ImagePartial",
"properties": {
"type": {
"const": "response.image_generation_call.partial_image",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ImageCall",
"properties": {
"type": {
"const": "response.image_generation_call.in_progress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ImageCall",
"properties": {
"type": {
"const": "response.image_generation_call.generating",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ImageCall",
"properties": {
"type": {
"const": "response.image_generation_call.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterEvent",
"properties": {
"type": {
"const": "response.code_interpreter_call.in_progress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterEvent",
"properties": {
"type": {
"const": "response.code_interpreter_call.interpreting",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterEvent",
"properties": {
"type": {
"const": "response.code_interpreter_call.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolCallEvent",
"properties": {
"type": {
"const": "response.file_search_call.in_progress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolCallEvent",
"properties": {
"type": {
"const": "response.file_search_call.searching",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolCallEvent",
"properties": {
"type": {
"const": "response.file_search_call.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolCallEvent",
"properties": {
"type": {
"const": "response.web_search_call.in_progress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolCallEvent",
"properties": {
"type": {
"const": "response.web_search_call.searching",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolCallEvent",
"properties": {
"type": {
"const": "response.web_search_call.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpArgumentsDelta",
"properties": {
"type": {
"const": "response.mcp_call_arguments.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpArgumentsDone",
"properties": {
"type": {
"const": "response.mcp_call_arguments.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpCallEvent",
"properties": {
"type": {
"const": "response.mcp_call.in_progress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpCallEvent",
"properties": {
"type": {
"const": "response.mcp_call.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpCallEvent",
"properties": {
"type": {
"const": "response.mcp_call.failed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpListToolsEvent",
"properties": {
"type": {
"const": "response.mcp_list_tools.in_progress",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpListToolsEvent",
"properties": {
"type": {
"const": "response.mcp_list_tools.completed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpListToolsEvent",
"properties": {
"type": {
"const": "response.mcp_list_tools.failed",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ResponseStreamError",
"properties": {
"type": {
"const": "error",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"description": "A future event type is ignored by converters. Known event payloads remain strict.\nNative passthrough retains the original bytes rather than this marker.",
"properties": {
"type": {
"const": "unknown",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_StreamEvent2
Complete JSON Schema
Referenced structures: Output_ContentBlockDeltaEvent, Output_ContentBlockStartEvent, Output_ContentBlockStopEvent, Output_ErrorEvent, Output_MessageDeltaEvent, Output_MessageStartEvent, Output_MessageStopEvent, Output_PingEvent
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_MessageStartEvent",
"properties": {
"type": {
"const": "message_start",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ContentBlockStartEvent",
"properties": {
"type": {
"const": "content_block_start",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ContentBlockDeltaEvent",
"properties": {
"type": {
"const": "content_block_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ContentBlockStopEvent",
"properties": {
"type": {
"const": "content_block_stop",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_MessageDeltaEvent",
"properties": {
"type": {
"const": "message_delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_MessageStopEvent",
"properties": {
"type": {
"const": "message_stop",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_PingEvent",
"properties": {
"type": {
"const": "ping",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ErrorEvent",
"properties": {
"type": {
"const": "error",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_StreamImageQuality
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high",
"xhigh",
"max",
"auto"
],
"type": "string"
}Output_StreamLogprob
Complete JSON Schema
Referenced structures: Output_StreamTopLogprob
{
"additionalProperties": true,
"properties": {
"logprob": {
"type": "number"
},
"token": {
"type": "string"
},
"top_logprobs": {
"items": {
"$ref": "#/components/schemas/Output_StreamTopLogprob"
},
"type": [
"array",
"null"
]
}
},
"required": [
"token",
"logprob"
],
"type": "object"
}Output_StreamMessage
Complete JSON Schema
Referenced structures: Output_ContextManagementResponse, Output_DiagnosticsResponse, Output_GenerateContentResponseBodyType, Output_InputTransformation, Output_RefusalStopDetails, Output_ResponseContainer, Output_ResponseContentBlock, Output_ResponseRole, Output_StopReason, Output_Usage
{
"additionalProperties": true,
"properties": {
"container": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseContainer"
},
{
"type": "null"
}
]
},
"content": {
"items": {
"$ref": "#/components/schemas/Output_ResponseContentBlock"
},
"type": "array"
},
"context_management": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ContextManagementResponse"
},
{
"type": "null"
}
]
},
"diagnostics": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_DiagnosticsResponse"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"input_transformations": {
"items": {
"$ref": "#/components/schemas/Output_InputTransformation"
},
"type": [
"array",
"null"
]
},
"model": {
"type": "string"
},
"role": {
"$ref": "#/components/schemas/Output_ResponseRole"
},
"stop_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_RefusalStopDetails"
},
{
"type": "null"
}
]
},
"stop_reason": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_StopReason"
},
{
"type": "null"
}
]
},
"stop_sequence": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_GenerateContentResponseBodyType"
},
"usage": {
"$ref": "#/components/schemas/Output_Usage"
}
},
"required": [
"type",
"id",
"content",
"model",
"role",
"usage"
],
"type": "object"
}Output_StreamTopLogprob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"logprob": {
"type": [
"number",
"null"
]
},
"token": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_StringList
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"values": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_SummaryPartStatus
Complete JSON Schema
{
"enum": [
"incomplete"
],
"type": "string"
}Output_SummaryText
Complete JSON Schema
Referenced structures: Output_SummaryTextType
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_SummaryTextType"
}
},
"required": [
"type",
"text"
],
"type": "object"
}Output_SummaryTextType
Complete JSON Schema
{
"enum": [
"summary_text"
],
"type": "string"
}Output_TeamDto
Complete JSON Schema
{
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"oauthClientAllowlist": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"organizationId": {
"type": "string"
}
},
"required": [
"id",
"organizationId",
"name",
"oauthClientAllowlist",
"createdAtMs"
],
"type": "object"
}Output_TeamMemberDto
Complete JSON Schema
{
"properties": {
"role": {
"type": "string"
},
"teamId": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"teamId",
"userId",
"role"
],
"type": "object"
}Output_TextConfig
Complete JSON Schema
Referenced structures: Output_TextFormat, Output_TextVerbosity
{
"additionalProperties": true,
"properties": {
"format": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TextFormat"
},
{
"type": "null"
}
]
},
"verbosity": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TextVerbosity"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_TextDelta
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Output_TextEditorCreateResult
Complete JSON Schema
Referenced structures: Output_TextEditorCreateResultType
{
"additionalProperties": true,
"properties": {
"is_file_update": {
"type": "boolean"
},
"type": {
"$ref": "#/components/schemas/Output_TextEditorCreateResultType"
}
},
"required": [
"type",
"is_file_update"
],
"type": "object"
}Output_TextEditorCreateResultType
Complete JSON Schema
{
"enum": [
"text_editor_code_execution_create_result"
],
"type": "string"
}Output_TextEditorErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded",
"file_not_found"
],
"type": "string"
}Output_TextEditorFileType
Complete JSON Schema
{
"enum": [
"text",
"image",
"pdf"
],
"type": "string"
}Output_TextFormat
Complete JSON Schema
Referenced structures: Output_TextFormatJsonObject, Output_TextFormatJsonSchema, Output_TextFormatText
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_TextFormatText",
"properties": {
"type": {
"const": "text",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_TextFormatJsonSchema",
"properties": {
"type": {
"const": "json_schema",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_TextFormatJsonObject",
"properties": {
"type": {
"const": "json_object",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_TextFormatJsonObject
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_TextFormatJsonSchema
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
},
"schema": {
"additionalProperties": true,
"type": "object"
},
"strict": {
"type": [
"boolean",
"null"
]
}
},
"required": [
"name",
"schema"
],
"type": "object"
}Output_TextFormatText
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_TextFormatType
Complete JSON Schema
{
"enum": [
"text"
],
"type": "string"
}Output_TextMediaType
Complete JSON Schema
{
"enum": [
"text/plain"
],
"type": "string"
}Output_TextVerbosity
Complete JSON Schema
{
"enum": [
"low",
"medium",
"high"
],
"type": "string"
}Output_ThinkingBindingMismatchReason
Complete JSON Schema
{
"enum": [
"model_binding_mismatch",
"prefix_binding_mismatch",
"organization_binding_mismatch",
"end_user_binding_mismatch",
"unknown"
],
"type": "string"
}Output_ThinkingBlock
Complete JSON Schema
Referenced structures: Output_ThinkingBlockType
{
"additionalProperties": true,
"properties": {
"signature": {
"type": "string"
},
"thinking": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ThinkingBlockType"
}
},
"required": [
"type",
"signature",
"thinking"
],
"type": "object"
}Output_ThinkingBlockType
Complete JSON Schema
{
"enum": [
"thinking"
],
"type": "string"
}Output_ThinkingCapability
Complete JSON Schema
Referenced structures: Output_ThinkingTypes
{
"additionalProperties": true,
"properties": {
"supported": {
"type": "boolean"
},
"types": {
"$ref": "#/components/schemas/Output_ThinkingTypes"
}
},
"required": [
"supported",
"types"
],
"type": "object"
}Output_ThinkingDelta
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"thinking": {
"type": "string"
}
},
"required": [
"thinking"
],
"type": "object"
}Output_ThinkingTypes
Complete JSON Schema
Referenced structures: Output_CapabilitySupport
{
"additionalProperties": true,
"properties": {
"adaptive": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
"between_tools": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
{
"type": "null"
}
]
},
"disabled": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CapabilitySupport"
},
{
"type": "null"
}
]
},
"enabled": {
"$ref": "#/components/schemas/Output_CapabilitySupport"
}
},
"required": [
"adaptive",
"enabled"
],
"type": "object"
}Output_TlsPresetDto
Complete JSON Schema
{
"description": "One client identity, ready to be stored as a connection profile's\n`emulation`. The object is a `gproxy_client::EmulationConfig`, so a caller\ncopies it across unchanged rather than translating anything.",
"properties": {
"emulation": {
"description": "Only meaningful with the `wreq` backend; the others reject an emulation."
},
"id": {
"type": "string"
},
"label": {
"type": "string"
}
},
"required": [
"id",
"label",
"emulation"
],
"type": "object"
}Output_TokenLogprob
Complete JSON Schema
Referenced structures: Output_TokenLogprobTop
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"logprob": {
"format": "double",
"type": "number"
},
"token": {
"type": "string"
},
"top_logprobs": {
"items": {
"$ref": "#/components/schemas/Output_TokenLogprobTop"
},
"type": "array"
}
},
"required": [
"token",
"bytes",
"logprob",
"top_logprobs"
],
"type": "object"
}Output_TokenLogprobTop
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"logprob": {
"format": "double",
"type": "number"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"bytes",
"logprob"
],
"type": "object"
}Output_TokenResponse
Complete JSON Schema
{
"description": "RFC 6749 §5.1. Both token values are plaintext and exist only here.",
"properties": {
"access_token": {
"type": "string"
},
"expires_in": {
"description": "The access token's remaining lifetime, in **seconds**.",
"format": "int64",
"type": "integer"
},
"refresh_token": {
"description": "Rotated on every exchange: the one presented is consumed and this one\nreplaces it. Presenting a consumed refresh token revokes the whole\ngrant — see [`crate::operations::issuer`].",
"type": "string"
},
"scope": {
"description": "The granted scopes, space-delimited, as they are recorded on the grant.",
"type": "string"
},
"token_type": {
"description": "Always [`TOKEN_TYPE`].",
"type": "string"
}
},
"required": [
"access_token",
"token_type",
"expires_in",
"refresh_token",
"scope"
],
"type": "object"
}Output_TokenUsageType
Complete JSON Schema
{
"enum": [
"tokens"
],
"type": "string"
}Output_TokenizerAuthDto
Complete JSON Schema
{
"description": "Whether a source token is configured. The token itself is never reported\nby a read; `reveal_auth` is the one deliberate disclosure.",
"properties": {
"configured": {
"type": "boolean"
}
},
"required": [
"configured"
],
"type": "object"
}Output_TokenizerProgressDto
Complete JSON Schema
{
"properties": {
"downloadedBytes": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"filename": {
"type": "string"
},
"repo": {
"type": "string"
},
"totalBytes": {
"description": "From `Content-Length`, when the upstream sent one.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"repo",
"filename",
"downloadedBytes",
"totalBytes"
],
"type": "object"
}Output_Tool
Complete JSON Schema
Referenced structures: Output_ApplyPatchTool, Output_CodeInterpreterTool, Output_ComputerTool, Output_CustomTool, Output_FileSearchTool, Output_FunctionTool, Output_ImageGenerationTool, Output_McpTool, Output_NamespaceTool, Output_ShellTool, Output_ToolMarker, Output_ToolSearchTool, Output_WebSearchPreviewTool, Output_WebSearchTool
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_FunctionTool",
"properties": {
"type": {
"const": "function",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_FileSearchTool",
"properties": {
"type": {
"const": "file_search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ComputerTool",
"properties": {
"type": {
"const": "computer_use_preview",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolMarker",
"properties": {
"type": {
"const": "computer",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_WebSearchPreviewTool",
"properties": {
"type": {
"const": "web_search_preview",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_WebSearchPreviewTool",
"properties": {
"type": {
"const": "web_search_preview_2025_03_11",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_WebSearchTool",
"properties": {
"type": {
"const": "web_search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_WebSearchTool",
"properties": {
"type": {
"const": "web_search_2025_08_26",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CodeInterpreterTool",
"properties": {
"type": {
"const": "code_interpreter",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_CustomTool",
"properties": {
"type": {
"const": "custom",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_NamespaceTool",
"properties": {
"type": {
"const": "namespace",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolMarker",
"properties": {
"type": {
"const": "local_shell",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ShellTool",
"properties": {
"type": {
"const": "shell",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ImageGenerationTool",
"properties": {
"type": {
"const": "image_generation",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_McpTool",
"properties": {
"type": {
"const": "mcp",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolMarker",
"properties": {
"type": {
"const": "programmatic_tool_calling",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ApplyPatchTool",
"properties": {
"type": {
"const": "apply_patch",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_ToolSearchTool",
"properties": {
"type": {
"const": "tool_search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_ToolCall
Complete JSON Schema
Referenced structures: Output_ToolType
{
"additionalProperties": true,
"properties": {
"args": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"toolName": {
"type": [
"string",
"null"
]
},
"toolType": {
"$ref": "#/components/schemas/Output_ToolType"
}
},
"required": [
"toolType"
],
"type": "object"
}Output_ToolCallEvent
Complete JSON Schema
Referenced structures: Output_Agent
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"item_id": {
"type": "string"
},
"output_index": {
"format": "int64",
"type": "integer"
},
"sequence_number": {
"format": "int64",
"type": "integer"
}
},
"required": [
"sequence_number",
"item_id",
"output_index"
],
"type": "object"
}Output_ToolChoice
Complete JSON Schema
Referenced structures: Output_ToolChoiceAllowed, Output_ToolChoiceApplyPatch, Output_ToolChoiceCustom, Output_ToolChoiceFunction, Output_ToolChoiceHosted, Output_ToolChoiceMcp, Output_ToolChoiceMode, Output_ToolChoiceProgrammatic, Output_ToolChoiceShell
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolChoiceMode"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceAllowed"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceHosted"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceFunction"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceMcp"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceCustom"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceProgrammatic"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceApplyPatch"
},
{
"$ref": "#/components/schemas/Output_ToolChoiceShell"
}
]
}Output_ToolChoiceAllowed
Complete JSON Schema
Referenced structures: Output_AllowedToolChoiceMode, Output_ToolChoiceAllowedType
{
"additionalProperties": true,
"properties": {
"mode": {
"$ref": "#/components/schemas/Output_AllowedToolChoiceMode"
},
"tools": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceAllowedType"
}
},
"required": [
"type",
"mode",
"tools"
],
"type": "object"
}Output_ToolChoiceAllowedType
Complete JSON Schema
{
"enum": [
"allowed_tools"
],
"type": "string"
}Output_ToolChoiceApplyPatch
Complete JSON Schema
Referenced structures: Output_ToolChoiceApplyPatchType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceApplyPatchType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ToolChoiceApplyPatchType
Complete JSON Schema
{
"enum": [
"apply_patch"
],
"type": "string"
}Output_ToolChoiceCustom
Complete JSON Schema
Referenced structures: Output_ToolChoiceCustomType
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceCustomType"
}
},
"required": [
"type",
"name"
],
"type": "object"
}Output_ToolChoiceCustomType
Complete JSON Schema
{
"enum": [
"custom"
],
"type": "string"
}Output_ToolChoiceFunction
Complete JSON Schema
Referenced structures: Output_ToolChoiceFunctionType
{
"additionalProperties": true,
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceFunctionType"
}
},
"required": [
"type",
"name"
],
"type": "object"
}Output_ToolChoiceFunction2
Complete JSON Schema
Referenced structures: Output_ToolChoiceFunctionType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/tool_choice_function.py`, `ToolChoiceFunction`.",
"properties": {
"name": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceFunctionType2"
}
},
"required": [
"name",
"type"
],
"type": "object"
}Output_ToolChoiceFunctionType
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Output_ToolChoiceFunctionType2
Complete JSON Schema
{
"enum": [
"function"
],
"type": "string"
}Output_ToolChoiceHosted
Complete JSON Schema
Referenced structures: Output_ToolChoiceHostedType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceHostedType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ToolChoiceHostedType
Complete JSON Schema
{
"enum": [
"file_search",
"web_search_preview",
"computer",
"computer_use_preview",
"computer_use",
"code_interpreter",
"image_generation",
"web_search_preview_2025_03_11"
],
"type": "string"
}Output_ToolChoiceMcp
Complete JSON Schema
Referenced structures: Output_ToolChoiceMcpType
{
"additionalProperties": true,
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceMcpType"
}
},
"required": [
"type",
"server_label"
],
"type": "object"
}Output_ToolChoiceMcp2
Complete JSON Schema
Referenced structures: Output_ToolChoiceMcpType2
{
"additionalProperties": true,
"description": "Source: `openai/types/responses/tool_choice_mcp.py`, `ToolChoiceMcp`.",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"server_label": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceMcpType2"
}
},
"required": [
"server_label",
"type"
],
"type": "object"
}Output_ToolChoiceMcpType
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Output_ToolChoiceMcpType2
Complete JSON Schema
{
"enum": [
"mcp"
],
"type": "string"
}Output_ToolChoiceMode
Complete JSON Schema
{
"enum": [
"none",
"auto",
"required"
],
"type": "string"
}Output_ToolChoiceOptions
Complete JSON Schema
{
"description": "Source: `openai/types/responses/tool_choice_options.py`, `ToolChoiceOptions`.",
"enum": [
"none",
"auto",
"required"
],
"type": "string"
}Output_ToolChoiceProgrammatic
Complete JSON Schema
Referenced structures: Output_ToolChoiceProgrammaticType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceProgrammaticType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ToolChoiceProgrammaticType
Complete JSON Schema
{
"enum": [
"programmatic_tool_calling"
],
"type": "string"
}Output_ToolChoiceShell
Complete JSON Schema
Referenced structures: Output_ToolChoiceShellType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_ToolChoiceShellType"
}
},
"required": [
"type"
],
"type": "object"
}Output_ToolChoiceShellType
Complete JSON Schema
{
"enum": [
"shell"
],
"type": "string"
}Output_ToolExecution
Complete JSON Schema
{
"enum": [
"server",
"client"
],
"type": "string"
}Output_ToolMarker
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_ToolMessage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"parameters": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ToolMessages
Complete JSON Schema
Referenced structures: Output_CodeModeToolMessages, Output_IndirectDescriptionPrefixes, Output_McpResourceToolMessages, Output_MultiAgentToolMessages, Output_ToolMessage
{
"additionalProperties": true,
"properties": {
"code_mode": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CodeModeToolMessages"
},
{
"type": "null"
}
]
},
"functions_namespace_functions_description_prefixes": {
"additionalProperties": {
"type": "string"
},
"type": [
"object",
"null"
]
},
"indirect_description_prefixes": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_IndirectDescriptionPrefixes"
},
{
"type": "null"
}
]
},
"mcp_resources": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_McpResourceToolMessages"
},
{
"type": "null"
}
]
},
"multi_agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_MultiAgentToolMessages"
},
{
"type": "null"
}
]
},
"send_user_message_async": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolMessage"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_ToolMode
Complete JSON Schema
{
"enum": [
"direct",
"code_mode",
"code_mode_only"
],
"type": "string"
}Output_ToolResponse
Complete JSON Schema
Referenced structures: Output_ToolType
{
"additionalProperties": true,
"properties": {
"id": {
"type": [
"string",
"null"
]
},
"response": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"toolType": {
"$ref": "#/components/schemas/Output_ToolType"
}
},
"required": [
"toolType"
],
"type": "object"
}Output_ToolSearchCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_ItemStatus, Output_ToolExecution, Output_ToolSearchCallType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"arguments": true,
"call_id": {
"type": [
"string",
"null"
]
},
"execution": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolExecution"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"type": {
"$ref": "#/components/schemas/Output_ToolSearchCallType"
}
},
"required": [
"type",
"arguments"
],
"type": "object"
}Output_ToolSearchCallType
Complete JSON Schema
{
"enum": [
"tool_search_call"
],
"type": "string"
}Output_ToolSearchErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"too_many_requests",
"execution_time_exceeded"
],
"type": "string"
}Output_ToolSearchOutput
Complete JSON Schema
Referenced structures: Output_Agent, Output_ItemStatus, Output_Tool, Output_ToolExecution, Output_ToolSearchOutputType
{
"additionalProperties": true,
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"call_id": {
"type": [
"string",
"null"
]
},
"execution": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolExecution"
},
{
"type": "null"
}
]
},
"id": {
"type": [
"string",
"null"
]
},
"status": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ItemStatus"
},
{
"type": "null"
}
]
},
"tools": {
"items": {
"$ref": "#/components/schemas/Output_Tool"
},
"type": "array"
},
"type": {
"$ref": "#/components/schemas/Output_ToolSearchOutputType"
}
},
"required": [
"type",
"tools"
],
"type": "object"
}Output_ToolSearchOutputType
Complete JSON Schema
{
"enum": [
"tool_search_output"
],
"type": "string"
}Output_ToolSearchTool
Complete JSON Schema
Referenced structures: Output_ToolExecution
{
"additionalProperties": true,
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"execution": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ToolExecution"
},
{
"type": "null"
}
]
},
"parameters": true
},
"type": "object"
}Output_ToolType
Complete JSON Schema
{
"enum": [
"TOOL_TYPE_UNSPECIFIED",
"GOOGLE_SEARCH_WEB",
"GOOGLE_SEARCH_IMAGE",
"URL_CONTEXT",
"GOOGLE_MAPS",
"FILE_SEARCH"
],
"type": "string"
}Output_TopCandidates
Complete JSON Schema
Referenced structures: Output_LogprobCandidate
{
"additionalProperties": true,
"properties": {
"candidates": {
"items": {
"$ref": "#/components/schemas/Output_LogprobCandidate"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_TopLogprob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
},
"logprob": {
"type": "number"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"bytes",
"logprob"
],
"type": "object"
}Output_TranscriptionDiarized
Complete JSON Schema
Referenced structures: Output_TranscriptionDiarizedSegment, Output_TranscriptionTask, Output_TranscriptionUsage
{
"additionalProperties": true,
"properties": {
"duration": {
"type": "number"
},
"segments": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionDiarizedSegment"
},
"type": "array"
},
"task": {
"$ref": "#/components/schemas/Output_TranscriptionTask"
},
"text": {
"type": "string"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"duration",
"segments",
"task",
"text"
],
"type": "object"
}Output_TranscriptionDiarizedSegment
Complete JSON Schema
Referenced structures: Output_TranscriptionDiarizedSegmentType
{
"additionalProperties": true,
"properties": {
"end": {
"type": "number"
},
"id": {
"type": "string"
},
"speaker": {
"type": "string"
},
"start": {
"type": "number"
},
"text": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_TranscriptionDiarizedSegmentType"
}
},
"required": [
"id",
"end",
"speaker",
"start",
"text",
"type"
],
"type": "object"
}Output_TranscriptionDiarizedSegmentType
Complete JSON Schema
{
"enum": [
"transcript.text.segment"
],
"type": "string"
}Output_TranscriptionDurationUsage
Complete JSON Schema
Referenced structures: Output_DurationUsageType
{
"additionalProperties": true,
"properties": {
"seconds": {
"type": "number"
},
"type": {
"$ref": "#/components/schemas/Output_DurationUsageType"
}
},
"required": [
"seconds",
"type"
],
"type": "object"
}Output_TranscriptionInputTokenDetails
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"audio_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"text_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_TranscriptionJson
Complete JSON Schema
Referenced structures: Output_TranscriptionLanguage, Output_TranscriptionLogprob, Output_TranscriptionUsage
{
"additionalProperties": true,
"properties": {
"languages": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionLanguage"
},
"type": [
"array",
"null"
]
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionLogprob"
},
"type": [
"array",
"null"
]
},
"text": {
"type": "string"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"text"
],
"type": "object"
}Output_TranscriptionLanguage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"code": {
"type": "string"
}
},
"required": [
"code"
],
"type": "object"
}Output_TranscriptionLanguage2
Complete JSON Schema
{
"additionalProperties": true,
"description": "Source: `openai/types/audio/transcription_language.py`, `TranscriptionLanguage`.",
"properties": {
"code": {
"type": "string"
}
},
"required": [
"code"
],
"type": "object"
}Output_TranscriptionLogprob
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"bytes": {
"items": {
"format": "int64",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"logprob": {
"type": [
"number",
"null"
]
},
"token": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_TranscriptionSegment
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"avg_logprob": {
"type": "number"
},
"compression_ratio": {
"type": "number"
},
"end": {
"type": "number"
},
"id": {
"format": "int64",
"type": "integer"
},
"no_speech_prob": {
"type": "number"
},
"seek": {
"format": "int64",
"type": "integer"
},
"start": {
"type": "number"
},
"temperature": {
"type": "number"
},
"text": {
"type": "string"
},
"tokens": {
"items": {
"format": "int64",
"type": "integer"
},
"type": "array"
}
},
"required": [
"id",
"avg_logprob",
"compression_ratio",
"end",
"no_speech_prob",
"seek",
"start",
"temperature",
"text",
"tokens"
],
"type": "object"
}Output_TranscriptionStreamEvent
Complete JSON Schema
Referenced structures: Output_TranscriptionDiarizedSegment, Output_TranscriptionTextStreamEvent
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionTextStreamEvent"
},
{
"$ref": "#/components/schemas/Output_TranscriptionDiarizedSegment"
}
]
}Output_TranscriptionTask
Complete JSON Schema
{
"enum": [
"transcribe"
],
"type": "string"
}Output_TranscriptionTextDelta
Complete JSON Schema
Referenced structures: Output_TranscriptionLogprob
{
"additionalProperties": true,
"properties": {
"delta": {
"type": "string"
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionLogprob"
},
"type": [
"array",
"null"
]
},
"segment_id": {
"type": [
"string",
"null"
]
}
},
"required": [
"delta"
],
"type": "object"
}Output_TranscriptionTextDone
Complete JSON Schema
Referenced structures: Output_TranscriptionLanguage, Output_TranscriptionLogprob, Output_TranscriptionTokenUsage
{
"additionalProperties": true,
"properties": {
"languages": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionLanguage"
},
"type": [
"array",
"null"
]
},
"logprobs": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionLogprob"
},
"type": [
"array",
"null"
]
},
"text": {
"type": "string"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionTokenUsage"
},
{
"type": "null"
}
]
}
},
"required": [
"text"
],
"type": "object"
}Output_TranscriptionTextStreamEvent
Complete JSON Schema
Referenced structures: Output_TranscriptionTextDelta, Output_TranscriptionTextDone
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionTextDelta",
"properties": {
"type": {
"const": "transcript.text.delta",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_TranscriptionTextDone",
"properties": {
"type": {
"const": "transcript.text.done",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_TranscriptionTokenUsage
Complete JSON Schema
Referenced structures: Output_TokenUsageType, Output_TranscriptionInputTokenDetails
{
"additionalProperties": true,
"properties": {
"input_token_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionInputTokenDetails"
},
{
"type": "null"
}
]
},
"input_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"total_tokens": {
"format": "int64",
"type": "integer"
},
"type": {
"$ref": "#/components/schemas/Output_TokenUsageType"
}
},
"required": [
"input_tokens",
"output_tokens",
"total_tokens",
"type"
],
"type": "object"
}Output_TranscriptionUsage
Complete JSON Schema
Referenced structures: Output_TranscriptionDurationUsage, Output_TranscriptionTokenUsage
{
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionTokenUsage"
},
{
"$ref": "#/components/schemas/Output_TranscriptionDurationUsage"
}
]
}Output_TranscriptionVerbose
Complete JSON Schema
Referenced structures: Output_TranscriptionDurationUsage, Output_TranscriptionSegment, Output_TranscriptionTask, Output_TranscriptionWord
{
"additionalProperties": true,
"properties": {
"duration": {
"type": "number"
},
"language": {
"type": "string"
},
"segments": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionSegment"
},
"type": [
"array",
"null"
]
},
"task": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionTask"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"usage": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_TranscriptionDurationUsage"
},
{
"type": "null"
}
]
},
"words": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionWord"
},
"type": [
"array",
"null"
]
}
},
"required": [
"duration",
"language",
"text"
],
"type": "object"
}Output_TranscriptionWord
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"end": {
"type": "number"
},
"start": {
"type": "number"
},
"word": {
"type": "string"
}
},
"required": [
"end",
"start",
"word"
],
"type": "object"
}Output_TranslationJson
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Output_TranslationVerbose
Complete JSON Schema
Referenced structures: Output_TranscriptionSegment
{
"additionalProperties": true,
"properties": {
"duration": {
"type": "number"
},
"language": {
"type": "string"
},
"segments": {
"items": {
"$ref": "#/components/schemas/Output_TranscriptionSegment"
},
"type": [
"array",
"null"
]
},
"text": {
"type": "string"
}
},
"required": [
"duration",
"language",
"text"
],
"type": "object"
}Output_TruncationMode
Complete JSON Schema
{
"enum": [
"bytes",
"tokens"
],
"type": "string"
}Output_TruncationPolicyConfig
Complete JSON Schema
Referenced structures: Output_TruncationMode
{
"additionalProperties": true,
"properties": {
"limit": {
"format": "int64",
"type": "integer"
},
"mode": {
"$ref": "#/components/schemas/Output_TruncationMode"
}
},
"required": [
"mode",
"limit"
],
"type": "object"
}Output_TurnCompleteReason
Complete JSON Schema
{
"enum": [
"TURN_COMPLETE_REASON_UNSPECIFIED",
"MALFORMED_FUNCTION_CALL",
"RESPONSE_REJECTED",
"NEED_MORE_INPUT",
"PROHIBITED_INPUT_CONTENT",
"IMAGE_PROHIBITED_INPUT_CONTENT",
"INPUT_TEXT_CONTAIN_PROMINENT_PERSON_PROHIBITED",
"INPUT_IMAGE_CELEBRITY",
"INPUT_IMAGE_PHOTO_REALISTIC_CHILD_PROHIBITED",
"INPUT_TEXT_NCII_PROHIBITED",
"INPUT_OTHER",
"INPUT_IP_PROHIBITED",
"BLOCKLIST",
"UNSAFE_PROMPT_FOR_IMAGE_GENERATION",
"GENERATED_IMAGE_SAFETY",
"GENERATED_CONTENT_SAFETY",
"GENERATED_AUDIO_SAFETY",
"GENERATED_VIDEO_SAFETY",
"GENERATED_CONTENT_PROHIBITED",
"GENERATED_CONTENT_BLOCKLIST",
"GENERATED_IMAGE_PROHIBITED",
"GENERATED_IMAGE_CELEBRITY",
"GENERATED_IMAGE_PROMINENT_PEOPLE_DETECTED_BY_REWRITER",
"GENERATED_IMAGE_IDENTIFIABLE_PEOPLE",
"GENERATED_IMAGE_MINORS",
"OUTPUT_IMAGE_IP_PROHIBITED",
"GENERATED_OTHER",
"MAX_REGENERATION_REACHED"
],
"type": "string"
}Output_TypeAction
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"text": {
"type": "string"
}
},
"required": [
"text"
],
"type": "object"
}Output_UpdateProgress
Complete JSON Schema
{
"description": "Live byte counts and the current installation phase.",
"properties": {
"downloaded_bytes": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"phase": {
"type": "string"
},
"total_bytes": {
"format": "uint64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"phase",
"downloaded_bytes",
"total_bytes"
],
"type": "object"
}Output_UpdateReport
Complete JSON Schema
{
"description": "One check's answer.",
"properties": {
"available": {
"description": "Whether `latest` is actually newer than `current`.",
"type": "boolean"
},
"channel": {
"type": "string"
},
"checked_at_ms": {
"description": "When this check completed, in milliseconds since the epoch.",
"format": "int64",
"type": "integer"
},
"current": {
"description": "The version this process is running.",
"type": "string"
},
"latest": {
"description": "The version the manifest offers for this channel.",
"type": "string"
},
"notes": {
"description": "The notes themselves, when the host could fetch them. Never required:\na release with no readable notes is still a release.",
"type": [
"string",
"null"
]
},
"notes_url": {
"description": "Where a human reads what changed. Straight from the manifest.",
"type": [
"string",
"null"
]
},
"restart": {
"description": "What the host will do to the process after an apply: `none`,\n`supervisor` or `re-exec`.",
"type": "string"
},
"rollback_available": {
"description": "Whether a previous executable is still on disk to go back to.",
"type": "boolean"
},
"source": {
"type": "string"
},
"target": {
"description": "The artifact key the manifest was searched for, e.g.\n`x86_64-unknown-linux-gnu`.",
"type": "string"
}
},
"required": [
"current",
"latest",
"available",
"channel",
"source",
"target",
"notes_url",
"notes",
"restart",
"rollback_available",
"checked_at_ms"
],
"type": "object"
}Output_UpdateSchedule
Complete JSON Schema
Referenced structures: Output_UpdateReport
{
"description": "What the scheduled check has found so far, and whether there is a schedule.",
"properties": {
"automatic": {
"description": "Whether this instance installs what it finds without being asked.\n**Off unless an operator turned it on**, and reported either way so a\nconsole can say which.",
"type": "boolean"
},
"channel": {
"type": "string"
},
"interval_secs": {
"description": "Seconds between checks, or `None` when checking is switched off.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"last_check": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UpdateReport"
},
{
"type": "null"
}
],
"description": "The last completed check, or `None` when none has finished yet — a\nprocess that started a minute ago, or one whose every check failed."
},
"last_error": {
"description": "Why the last check failed, when one did and none has since succeeded.\nA console shows this rather than an empty panel that looks like \"no\nupdate available\".",
"type": [
"string",
"null"
]
},
"source": {
"type": "string"
},
"verify_signature": {
"type": "boolean"
}
},
"required": [
"last_check",
"last_error",
"interval_secs",
"automatic",
"verify_signature",
"channel",
"source"
],
"type": "object"
}Output_UploadFileResponseBody
Complete JSON Schema
Referenced structures: Output_File
{
"additionalProperties": true,
"properties": {
"file": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_File"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_UrlCitation
Complete JSON Schema
Referenced structures: Output_UrlCitationType
{
"additionalProperties": true,
"properties": {
"end_index": {
"format": "int64",
"type": "integer"
},
"start_index": {
"format": "int64",
"type": "integer"
},
"title": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/Output_UrlCitationType"
},
"url": {
"type": "string"
}
},
"required": [
"end_index",
"start_index",
"title",
"url",
"type"
],
"type": "object"
}Output_UrlCitation2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"end_index": {
"format": "int64",
"type": "integer"
},
"start_index": {
"format": "int64",
"type": "integer"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"end_index",
"start_index",
"title",
"url"
],
"type": "object"
}Output_UrlCitationType
Complete JSON Schema
{
"enum": [
"url_citation"
],
"type": "string"
}Output_UrlContextMetadata
Complete JSON Schema
Referenced structures: Output_UrlMetadata
{
"additionalProperties": true,
"properties": {
"urlMetadata": {
"items": {
"$ref": "#/components/schemas/Output_UrlMetadata"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_UrlMetadata
Complete JSON Schema
Referenced structures: Output_UrlRetrievalStatus
{
"additionalProperties": true,
"properties": {
"retrievedUrl": {
"type": [
"string",
"null"
]
},
"urlRetrievalStatus": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UrlRetrievalStatus"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_UrlRetrievalStatus
Complete JSON Schema
{
"enum": [
"URL_RETRIEVAL_STATUS_UNSPECIFIED",
"URL_RETRIEVAL_STATUS_SUCCESS",
"URL_RETRIEVAL_STATUS_ERROR",
"URL_RETRIEVAL_STATUS_PAYWALL",
"URL_RETRIEVAL_STATUS_UNSAFE"
],
"type": "string"
}Output_Usage
Complete JSON Schema
Referenced structures: Output_CacheCreation, Output_FallbackCreditUsage, Output_IterationUsage, Output_OutputTokensDetails, Output_ResponseServiceTier, Output_ServerToolUsage, Output_Speed
{
"additionalProperties": true,
"properties": {
"cache_creation": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CacheCreation"
},
{
"type": "null"
}
]
},
"cache_creation_input_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"cache_read_input_tokens": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"fallback_credit": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_FallbackCreditUsage"
},
{
"type": "null"
}
]
},
"inference_geo": {
"type": [
"string",
"null"
]
},
"input_tokens": {
"format": "int64",
"type": "integer"
},
"iterations": {
"items": {
"$ref": "#/components/schemas/Output_IterationUsage"
},
"type": [
"array",
"null"
]
},
"output_tokens": {
"format": "int64",
"type": "integer"
},
"output_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_OutputTokensDetails"
},
{
"type": "null"
}
]
},
"server_tool_use": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ServerToolUsage"
},
{
"type": "null"
}
]
},
"service_tier": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ResponseServiceTier"
},
{
"type": "null"
}
]
},
"speed": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Speed"
},
{
"type": "null"
}
]
}
},
"required": [
"input_tokens",
"output_tokens"
],
"type": "object"
}Output_Usage2
Complete JSON Schema
Referenced structures: Output_CompletionTokensDetails, Output_PromptTokensDetails
{
"additionalProperties": true,
"properties": {
"completion_tokens": {
"format": "int64",
"type": "integer"
},
"completion_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_CompletionTokensDetails"
},
{
"type": "null"
}
]
},
"prompt_tokens": {
"format": "int64",
"type": "integer"
},
"prompt_tokens_details": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PromptTokensDetails"
},
{
"type": "null"
}
]
},
"total_tokens": {
"format": "int64",
"type": "integer"
}
},
"required": [
"prompt_tokens",
"completion_tokens",
"total_tokens"
],
"type": "object"
}Output_UsageExchangeDto
Complete JSON Schema
Referenced structures: Output_UsageTokensDto
{
"description": "One upstream attempt inside a request: which provider and credential\nserved it, and what it cost on its own.",
"properties": {
"actualServiceTier": {
"type": [
"string",
"null"
]
},
"attemptId": {
"type": [
"string",
"null"
]
},
"attemptOrdinal": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"captureId": {
"type": [
"string",
"null"
]
},
"completeness": {
"type": [
"string",
"null"
]
},
"cost": {
"type": [
"string",
"null"
]
},
"credentialId": {
"type": [
"string",
"null"
]
},
"currency": {
"type": [
"string",
"null"
]
},
"metrics": {
"description": "Dynamic dimensions and nested protocol-specific usage detail."
},
"model": {
"description": "The upstream model name, which need not be the requested one.",
"type": [
"string",
"null"
]
},
"providerId": {
"type": [
"string",
"null"
]
},
"quantities": {
"additionalProperties": {
"type": "string"
},
"description": "Reported media/tool quantities, as exact decimal strings. Missing is unknown.",
"type": "object"
},
"tokens": {
"$ref": "#/components/schemas/Output_UsageTokensDto"
}
},
"required": [
"captureId",
"completeness",
"actualServiceTier",
"metrics",
"attemptId",
"attemptOrdinal",
"providerId",
"credentialId",
"model",
"tokens",
"quantities",
"cost",
"currency"
],
"type": "object"
}Output_UsageGroupDto
Complete JSON Schema
Referenced structures: Output_UsageSummaryDto
{
"description": "One bucket of a grouped aggregate.",
"properties": {
"key": {
"description": "The grouping column's value. None is \"the records carried none\" — an\nanonymous request has no user, a failed attempt no provider.",
"type": [
"string",
"null"
]
},
"summary": {
"$ref": "#/components/schemas/Output_UsageSummaryDto",
"description": "`truncated` and `scanned` describe the one scan every group came from,\nnot this group alone."
}
},
"required": [
"key",
"summary"
],
"type": "object"
}Output_UsageMetadata
Complete JSON Schema
Referenced structures: Output_ModalityTokenCount, Output_ServiceTier2
{
"additionalProperties": true,
"properties": {
"cacheTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"cachedContentTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"candidatesTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"candidatesTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"promptTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"promptTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"serviceTier": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_ServiceTier2"
},
{
"type": "null"
}
]
},
"thoughtsTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"toolUsePromptTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"toolUsePromptTokensDetails": {
"items": {
"$ref": "#/components/schemas/Output_ModalityTokenCount"
},
"type": [
"array",
"null"
]
},
"totalTokenCount": {
"format": "int64",
"type": [
"integer",
"null"
]
}
},
"type": "object"
}Output_UsageRecordDto
Complete JSON Schema
Referenced structures: Output_UsageExchangeDto, Output_UsageTokensDto
{
"description": "One persisted physical upstream call.",
"properties": {
"actualServiceTier": {
"type": [
"string",
"null"
]
},
"apiKeyId": {
"type": [
"string",
"null"
]
},
"completeness": {
"description": "`complete`, `partial` or `unknown`.",
"type": [
"string",
"null"
]
},
"cost": {
"description": "The settled USD charge, read from its dedicated column.",
"type": [
"string",
"null"
]
},
"currency": {
"type": [
"string",
"null"
]
},
"durationMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"endedAtMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"exchanges": {
"description": "Detail of this physical call, retaining the existing exchange DTO shape.",
"items": {
"$ref": "#/components/schemas/Output_UsageExchangeDto"
},
"type": "array"
},
"metrics": {
"description": "Dynamic dimensions and nested protocol-specific detail; fixed fields are above."
},
"model": {
"description": "The upstream model that produced this usage.",
"type": "string"
},
"operation": {
"type": "string"
},
"quantities": {
"additionalProperties": {
"type": "string"
},
"description": "Reported media/tool quantities, as exact decimal strings. Missing is unknown.",
"type": "object"
},
"requestId": {
"description": "Physical upstream call ID. A corresponding capture log need not exist.",
"type": "string"
},
"startedAtMs": {
"format": "int64",
"type": "integer"
},
"state": {
"description": "The settlement state core recorded: `settled`, `failed`, … .",
"type": [
"string",
"null"
]
},
"tokens": {
"$ref": "#/components/schemas/Output_UsageTokensDto"
},
"ttftMs": {
"format": "int64",
"type": [
"integer",
"null"
]
},
"userId": {
"type": [
"string",
"null"
]
}
},
"required": [
"requestId",
"userId",
"apiKeyId",
"model",
"operation",
"state",
"completeness",
"actualServiceTier",
"tokens",
"quantities",
"cost",
"currency",
"exchanges",
"metrics",
"startedAtMs",
"endedAtMs",
"durationMs",
"ttftMs"
],
"type": "object"
}Output_UsageRecordPage
Complete JSON Schema
Referenced structures: Output_UsageRecordDto
{
"description": "One exact database page; provider and credential filters are SQL predicates.",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Output_UsageRecordDto"
},
"type": "array"
},
"limit": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"offset": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"total": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"items",
"total",
"offset",
"limit",
"truncated"
],
"type": "object"
}Output_UsageSummaryDto
Complete JSON Schema
Referenced structures: Output_CacheCreationDto
{
"description": "Totals over the records a scan covered.",
"properties": {
"averageOutputTps": {
"description": "Output tokens per second of generation time, excluding first-token wait.\nOnly records with reported output tokens, TTFT and positive generation time contribute.",
"format": "double",
"type": [
"number",
"null"
]
},
"cacheCreation": {
"items": {
"$ref": "#/components/schemas/Output_CacheCreationDto"
},
"type": "array"
},
"cacheCreationTokens": {
"description": "Total reported cache writes across all retention periods.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"cachedInputTokens": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"cost": {
"description": "A normalized decimal string, `\"0\"` when nothing was priced.",
"type": "string"
},
"currency": {
"description": "USD when any record was priced; None when none was priced.",
"type": [
"string",
"null"
]
},
"inputTokens": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"outputTokens": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"quantities": {
"additionalProperties": {
"type": "string"
},
"description": "Totals of reported media/tool quantities; keys are billable metric names.",
"type": "object"
},
"reasoningTokens": {
"description": "Part of `output_tokens`, listed rather than added.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"requests": {
"description": "Number of physical upstream calls, independent of downstream association count.",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"scanned": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"truncated": {
"description": "The scan stopped at its row cap. The numbers describe `scanned`\nrecords, not every record the filters match.",
"type": "boolean"
}
},
"required": [
"requests",
"inputTokens",
"outputTokens",
"averageOutputTps",
"cachedInputTokens",
"cacheCreationTokens",
"cacheCreation",
"reasoningTokens",
"quantities",
"cost",
"currency",
"truncated",
"scanned"
],
"type": "object"
}Output_UsageTokensDto
Complete JSON Schema
Referenced structures: Output_CacheCreationDto
{
"description": "Token counts exactly as the upstream reported them.",
"properties": {
"cacheCreation": {
"items": {
"$ref": "#/components/schemas/Output_CacheCreationDto"
},
"type": "array"
},
"cachedInputTokens": {
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"inputTokens": {
"description": "Ordinary input, excluding cache reads and cache writes.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"outputTokens": {
"description": "Total output, reasoning included.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
},
"reasoningTokens": {
"description": "A subset of `output_tokens`, never additive with it.",
"format": "uint64",
"minimum": 0,
"type": [
"integer",
"null"
]
}
},
"required": [
"inputTokens",
"outputTokens",
"cachedInputTokens",
"cacheCreation",
"reasoningTokens"
],
"type": "object"
}Output_UsageTrendPointDto
Complete JSON Schema
Referenced structures: Output_UsageSummaryDto
{
"description": "One fixed-width bucket of a trend. Present even when empty.",
"properties": {
"endMs": {
"description": "Exclusive, always `start_ms + bucketMs`: the last bucket keeps the\nwidth of the others even when the requested range ends inside it.",
"format": "int64",
"type": "integer"
},
"startMs": {
"format": "int64",
"type": "integer"
},
"summary": {
"$ref": "#/components/schemas/Output_UsageSummaryDto"
}
},
"required": [
"startMs",
"endMs",
"summary"
],
"type": "object"
}Output_UserDto
Complete JSON Schema
{
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"enabled": {
"type": "boolean"
},
"hasPassword": {
"description": "Whether a console/portal password is set. `password_hash` itself has no\nfield here and no accessor anywhere.",
"type": "boolean"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"oauthClientAllowlist": {
"description": "None inherits the levels above; an empty list denies every client for\nthis user.",
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"role": {
"description": "Instance-wide role, `admin` or `user`. Organization and team roles are\nmemberships and are not this.",
"type": "string"
}
},
"required": [
"id",
"name",
"role",
"enabled",
"hasPassword",
"oauthClientAllowlist",
"createdAtMs"
],
"type": "object"
}Output_UserLocation
Complete JSON Schema
Referenced structures: Output_UserLocationType
{
"additionalProperties": true,
"properties": {
"city": {
"type": [
"string",
"null"
]
},
"country": {
"type": [
"string",
"null"
]
},
"region": {
"type": [
"string",
"null"
]
},
"timezone": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UserLocationType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_UserLocationType
Complete JSON Schema
{
"enum": [
"approximate"
],
"type": "string"
}Output_UserSessionDto
Complete JSON Schema
{
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"expiresAtMs": {
"format": "int64",
"type": "integer"
},
"id": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"id",
"userId",
"createdAtMs",
"expiresAtMs"
],
"type": "object"
}Output_VadSignalType
Complete JSON Schema
{
"enum": [
"VAD_SIGNAL_TYPE_UNSPECIFIED",
"VAD_SIGNAL_TYPE_SOS",
"VAD_SIGNAL_TYPE_EOS"
],
"type": "string"
}Output_VideoFileMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"videoDuration": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_VideoMetadata
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endOffset": {
"type": [
"string",
"null"
]
},
"fps": {
"format": "double",
"type": [
"number",
"null"
]
},
"startOffset": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_VocabularyDto
Complete JSON Schema
{
"description": "One stored vocabulary.",
"properties": {
"createdAtMs": {
"format": "int64",
"type": "integer"
},
"fileId": {
"type": "string"
},
"filename": {
"type": [
"string",
"null"
]
},
"isDefault": {
"description": "Whether it is the instance default.",
"type": "boolean"
},
"models": {
"description": "The catalog models that select it, by id.",
"items": {
"type": "string"
},
"type": "array"
},
"sizeBytes": {
"format": "int64",
"type": "integer"
}
},
"required": [
"fileId",
"filename",
"sizeBytes",
"createdAtMs",
"models",
"isDefault"
],
"type": "object"
}Output_Voice
Complete JSON Schema
Referenced structures: Output_VoiceSource
{
"additionalProperties": true,
"properties": {
"created_at": {
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"object": {
"type": "string"
},
"prompt": {
"type": [
"string",
"null"
]
},
"type": {
"$ref": "#/components/schemas/Output_VoiceSource"
}
},
"required": [
"id",
"created_at",
"name",
"object",
"type"
],
"type": "object"
}Output_VoiceActivity
Complete JSON Schema
Referenced structures: Output_VoiceActivityType
{
"additionalProperties": true,
"properties": {
"audioOffset": {
"type": [
"string",
"null"
]
},
"type": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VoiceActivityType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_VoiceActivityDetectionSignal
Complete JSON Schema
Referenced structures: Output_VadSignalType
{
"additionalProperties": true,
"properties": {
"vadSignalType": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_VadSignalType"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_VoiceActivityType
Complete JSON Schema
{
"enum": [
"TYPE_UNSPECIFIED",
"ACTIVITY_START",
"ACTIVITY_END"
],
"type": "string"
}Output_VoiceConsentSignature
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"signature": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_VoiceSource
Complete JSON Schema
{
"enum": [
"prompt",
"audio_sample"
],
"type": "string"
}Output_WaitAction
Complete JSON Schema
{
"additionalProperties": true,
"type": "object"
}Output_Web
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"title": {
"type": [
"string",
"null"
]
},
"uri": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_WebFetchError
Complete JSON Schema
Referenced structures: Output_WebFetchErrorCode, Output_WebFetchErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Output_WebFetchErrorCode"
},
"type": {
"$ref": "#/components/schemas/Output_WebFetchErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Output_WebFetchErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"url_too_long",
"url_not_allowed",
"url_not_in_prior_context",
"url_not_accessible",
"unsupported_content_type",
"too_many_requests",
"max_uses_exceeded",
"unavailable"
],
"type": "string"
}Output_WebFetchErrorType
Complete JSON Schema
{
"enum": [
"web_fetch_tool_result_error"
],
"type": "string"
}Output_WebSearchAction
Complete JSON Schema
Referenced structures: Output_WebSearchFindInPage, Output_WebSearchOpenPage, Output_WebSearchQuery
{
"oneOf": [
{
"$ref": "#/components/schemas/Output_WebSearchQuery",
"properties": {
"type": {
"const": "search",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_WebSearchOpenPage",
"properties": {
"type": {
"const": "open_page",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"$ref": "#/components/schemas/Output_WebSearchFindInPage",
"properties": {
"type": {
"const": "find_in_page",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
}
]
}Output_WebSearchCall
Complete JSON Schema
Referenced structures: Output_Agent, Output_WebSearchAction, Output_WebSearchCallType, Output_WebSearchStatus
{
"additionalProperties": true,
"properties": {
"action": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_WebSearchAction"
},
{
"type": "null"
}
],
"description": "The initial in-progress stream item precedes its search action."
},
"agent": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_Agent"
},
{
"type": "null"
}
]
},
"id": {
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Output_WebSearchStatus"
},
"type": {
"$ref": "#/components/schemas/Output_WebSearchCallType"
}
},
"required": [
"type",
"id",
"status"
],
"type": "object"
}Output_WebSearchCallType
Complete JSON Schema
{
"enum": [
"web_search_call"
],
"type": "string"
}Output_WebSearchError
Complete JSON Schema
Referenced structures: Output_WebSearchErrorCode, Output_WebSearchErrorType
{
"additionalProperties": true,
"properties": {
"error_code": {
"$ref": "#/components/schemas/Output_WebSearchErrorCode"
},
"type": {
"$ref": "#/components/schemas/Output_WebSearchErrorType"
}
},
"required": [
"type",
"error_code"
],
"type": "object"
}Output_WebSearchErrorCode
Complete JSON Schema
{
"enum": [
"invalid_tool_input",
"unavailable",
"max_uses_exceeded",
"too_many_requests",
"query_too_long",
"request_too_large"
],
"type": "string"
}Output_WebSearchErrorType
Complete JSON Schema
{
"enum": [
"web_search_tool_result_error"
],
"type": "string"
}Output_WebSearchFilters
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"allowed_domains": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_WebSearchFindInPage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"pattern": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"pattern"
],
"type": "object"
}Output_WebSearchOpenPage
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"url": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_WebSearchPreviewTool
Complete JSON Schema
Referenced structures: Output_PreviewUserLocation, Output_SearchContentType, Output_SearchContextSize
{
"additionalProperties": true,
"properties": {
"search_content_types": {
"items": {
"$ref": "#/components/schemas/Output_SearchContentType"
},
"type": [
"array",
"null"
]
},
"search_context_size": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SearchContextSize"
},
{
"type": "null"
}
]
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_PreviewUserLocation"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_WebSearchQuery
Complete JSON Schema
Referenced structures: Output_WebSearchSource
{
"additionalProperties": true,
"properties": {
"queries": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"query": {
"type": [
"string",
"null"
]
},
"sources": {
"items": {
"$ref": "#/components/schemas/Output_WebSearchSource"
},
"type": [
"array",
"null"
]
}
},
"type": "object"
}Output_WebSearchResponseBody
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"encrypted_output": {
"type": [
"string",
"null"
]
},
"output": {
"type": "string"
},
"results": {
"items": true,
"type": [
"array",
"null"
]
}
},
"required": [
"output"
],
"type": "object"
}Output_WebSearchSource
Complete JSON Schema
Referenced structures: Output_WebSearchSourceType
{
"additionalProperties": true,
"properties": {
"type": {
"$ref": "#/components/schemas/Output_WebSearchSourceType"
},
"url": {
"type": "string"
}
},
"required": [
"type",
"url"
],
"type": "object"
}Output_WebSearchSourceType
Complete JSON Schema
{
"enum": [
"url"
],
"type": "string"
}Output_WebSearchStatus
Complete JSON Schema
{
"enum": [
"in_progress",
"searching",
"completed",
"failed",
"incomplete"
],
"type": "string"
}Output_WebSearchTool
Complete JSON Schema
Referenced structures: Output_SearchContextSize, Output_UserLocation, Output_WebSearchFilters
{
"additionalProperties": true,
"properties": {
"filters": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_WebSearchFilters"
},
{
"type": "null"
}
]
},
"search_context_size": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_SearchContextSize"
},
{
"type": "null"
}
]
},
"user_location": {
"anyOf": [
{
"$ref": "#/components/schemas/Output_UserLocation"
},
{
"type": "null"
}
]
}
},
"type": "object"
}Output_WebSearchToolType
Complete JSON Schema
{
"enum": [
"text",
"text_and_image"
],
"type": "string"
}Output_WordInfo
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endOffset": {
"type": [
"string",
"null"
]
},
"startOffset": {
"type": [
"string",
"null"
]
},
"word": {
"type": "string"
}
},
"required": [
"word"
],
"type": "object"
}Output_WordInfo2
Complete JSON Schema
{
"additionalProperties": true,
"properties": {
"endOffset": {
"type": [
"string",
"null"
]
},
"startOffset": {
"type": [
"string",
"null"
]
},
"word": {
"type": [
"string",
"null"
]
}
},
"type": "object"
}Output_ZipMediaType
Complete JSON Schema
{
"enum": [
"application/zip"
],
"type": "string"
}