{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/compoid-com/json-schema/compoid-com-responses-request-schema.json", "title": "ResponsesRequest", "x-generated": "2026-11-04", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/compoid-com-openapi.yml#/components/schemas/ResponsesRequest", "properties": { "background": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Background", "default": false }, "include": { "anyOf": [ { "items": { "type": "string", "enum": [ "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": "array" }, { "type": "null" } ], "title": "Include" }, "input": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/EasyInputMessageParam" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__Message" }, { "$ref": "#/$defs/ResponseOutputMessageParam" }, { "$ref": "#/$defs/ResponseFileSearchToolCallParam" }, { "$ref": "#/$defs/ResponseComputerToolCallParam" }, { "$ref": "#/$defs/ComputerCallOutput" }, { "$ref": "#/$defs/ResponseFunctionWebSearchParam" }, { "$ref": "#/$defs/ResponseFunctionToolCallParam" }, { "$ref": "#/$defs/FunctionCallOutput" }, { "$ref": "#/$defs/ToolSearchCall" }, { "$ref": "#/$defs/ResponseToolSearchOutputItemParamParam" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__AdditionalTools" }, { "$ref": "#/$defs/ResponseConfigurationUpdateItemParamParam" }, { "$ref": "#/$defs/ResponseReasoningItemParam" }, { "$ref": "#/$defs/ResponseCompactionItemParamParam" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__ImageGenerationCall" }, { "$ref": "#/$defs/ResponseCodeInterpreterToolCallParam" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__LocalShellCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__LocalShellCallOutput" }, { "$ref": "#/$defs/ShellCall" }, { "$ref": "#/$defs/ShellCallOutput" }, { "$ref": "#/$defs/ApplyPatchCall" }, { "$ref": "#/$defs/ApplyPatchCallOutput" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__McpListTools" }, { "$ref": "#/$defs/McpApprovalRequest" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__McpApprovalResponse" }, { "$ref": "#/$defs/openai__types__responses__response_input_item_param__McpCall" }, { "$ref": "#/$defs/ResponseCustomToolCallOutputParam" }, { "$ref": "#/$defs/ResponseCustomToolCallParam" }, { "$ref": "#/$defs/CompactionTrigger" }, { "$ref": "#/$defs/ItemReference" }, { "$ref": "#/$defs/Program" }, { "$ref": "#/$defs/ProgramOutput" }, { "$ref": "#/$defs/ResponseOutputMessage" }, { "$ref": "#/$defs/ResponseFileSearchToolCall" }, { "$ref": "#/$defs/ResponseFunctionToolCall" }, { "$ref": "#/$defs/ResponseFunctionToolCallOutputItem" }, { "$ref": "#/$defs/ResponseFunctionWebSearch" }, { "$ref": "#/$defs/ResponseComputerToolCall" }, { "$ref": "#/$defs/ResponseComputerToolCallOutputItem" }, { "$ref": "#/$defs/ResponseReasoningItem" }, { "$ref": "#/$defs/Program" }, { "$ref": "#/$defs/ProgramOutput" }, { "$ref": "#/$defs/ResponseToolSearchCall" }, { "$ref": "#/$defs/ResponseToolSearchOutputItem" }, { "$ref": "#/$defs/openai__types__responses__response_output_item__AdditionalTools" }, { "$ref": "#/$defs/ResponseCompactionItem" }, { "$ref": "#/$defs/openai__types__responses__response_output_item__ImageGenerationCall" }, { "$ref": "#/$defs/ResponseCodeInterpreterToolCall" }, { "$ref": "#/$defs/openai__types__responses__response_output_item__LocalShellCall" }, { "$ref": "#/$defs/openai__types__responses__response_output_item__LocalShellCallOutput" }, { "$ref": "#/$defs/ResponseFunctionShellToolCall" }, { "$ref": "#/$defs/ResponseFunctionShellToolCallOutput" }, { "$ref": "#/$defs/ResponseApplyPatchToolCall" }, { "$ref": "#/$defs/ResponseApplyPatchToolCallOutput" }, { "$ref": "#/$defs/openai__types__responses__response_output_item__McpCall" }, { "$ref": "#/$defs/openai__types__responses__response_output_item__McpListTools" }, { "$ref": "#/$defs/McpApprovalRequest" }, { "$ref": "#/$defs/openai__types__responses__response_output_item__McpApprovalResponse" }, { "$ref": "#/$defs/ResponseCustomToolCall" }, { "$ref": "#/$defs/ResponseCustomToolCallOutputItem" } ] }, "type": "array" } ], "title": "Input" }, "instructions": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Instructions" }, "max_output_tokens": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Tokens" }, "max_tool_calls": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Tool Calls" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Metadata" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model" }, "logit_bias": { "anyOf": [ { "additionalProperties": { "type": "number" }, "type": "object" }, { "type": "null" } ], "title": "Logit Bias" }, "parallel_tool_calls": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Parallel Tool Calls", "default": true }, "previous_response_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Previous Response Id" }, "prompt": { "anyOf": [ { "$ref": "#/$defs/ResponsePrompt" }, { "type": "null" } ] }, "reasoning": { "anyOf": [ { "$ref": "#/$defs/openai__types__shared__reasoning__Reasoning" }, { "type": "null" } ] }, "include_reasoning": { "type": "boolean", "title": "Include Reasoning", "description": "Whether to include reasoning content in the response. When false, reasoning tokens are still generated but excluded from the output. This reduces network traffic without affecting model inference.", "default": true }, "service_tier": { "type": "string", "enum": [ "auto", "default", "flex", "scale", "priority" ], "title": "Service Tier", "default": "auto" }, "store": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Store", "default": true }, "stream": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Stream", "default": false }, "temperature": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Temperature" }, "text": { "anyOf": [ { "$ref": "#/$defs/ResponseTextConfig" }, { "type": "null" } ] }, "tool_choice": { "anyOf": [ { "type": "string", "enum": [ "none", "auto", "required" ] }, { "$ref": "#/$defs/ToolChoiceAllowed" }, { "$ref": "#/$defs/ToolChoiceTypes" }, { "$ref": "#/$defs/ToolChoiceFunction" }, { "$ref": "#/$defs/ToolChoiceMcp" }, { "$ref": "#/$defs/ToolChoiceCustom" }, { "$ref": "#/$defs/ToolChoiceSpecificProgrammaticToolCallingParam" }, { "$ref": "#/$defs/ToolChoiceApplyPatch" }, { "$ref": "#/$defs/ToolChoiceShell" } ], "title": "Tool Choice", "default": "auto" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/FunctionTool" }, { "$ref": "#/$defs/FileSearchTool" }, { "$ref": "#/$defs/ComputerTool" }, { "$ref": "#/$defs/ComputerUsePreviewTool" }, { "$ref": "#/$defs/WebSearchTool" }, { "$ref": "#/$defs/openai__types__responses__tool__Mcp" }, { "$ref": "#/$defs/openai__types__responses__tool__CodeInterpreter" }, { "$ref": "#/$defs/ProgrammaticToolCalling" }, { "$ref": "#/$defs/openai__types__responses__tool__ImageGeneration" }, { "$ref": "#/$defs/LocalShell" }, { "$ref": "#/$defs/FunctionShellTool" }, { "$ref": "#/$defs/CustomTool" }, { "$ref": "#/$defs/NamespaceTool" }, { "$ref": "#/$defs/ToolSearchTool" }, { "$ref": "#/$defs/WebSearchPreviewTool" }, { "$ref": "#/$defs/ApplyPatchTool" } ] }, "type": "array", "title": "Tools" }, "top_logprobs": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top Logprobs", "default": 0 }, "top_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Top P" }, "top_k": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Top K" }, "min_p": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min P" }, "truncation": { "anyOf": [ { "type": "string", "enum": [ "auto", "disabled" ] }, { "type": "null" } ], "title": "Truncation", "default": "disabled" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "skip_special_tokens": { "type": "boolean", "title": "Skip Special Tokens", "default": true }, "include_stop_str_in_output": { "type": "boolean", "title": "Include Stop Str In Output", "default": false }, "presence_penalty": { "anyOf": [ { "type": "number", "maximum": 2.0, "minimum": -2.0 }, { "type": "null" } ], "title": "Presence Penalty", "description": "The presence penalty that was used to penalize new tokens based on whether they appear in the text so far." }, "frequency_penalty": { "anyOf": [ { "type": "number", "maximum": 2.0, "minimum": -2.0 }, { "type": "null" } ], "title": "Frequency Penalty", "description": "The frequency penalty that was used to penalize new tokens based on their frequency in the text so far." }, "prompt_cache_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prompt Cache Key", "description": "A key that was used to read from or write to the prompt cache.Note: This field has not been implemented yet and vLLM will ignore it." }, "watermarking": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Watermarking" }, "request_id": { "type": "string", "title": "Request Id", "description": "The request_id related to this request. If the caller does not set it, a random_uuid will be generated. This id is used through out the inference process and return in response." }, "session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Session Id", "description": "Stable session identity shared by related requests. Unlike request_id, this value is expected to remain stable across multiple requests in the same conversation or agent session." }, "media_io_kwargs": { "anyOf": [ { "additionalProperties": { "additionalProperties": true, "type": "object" }, "type": "object" }, { "type": "null" } ], "title": "Media Io Kwargs", "description": "Additional kwargs to pass to the media IO connectors, keyed by modality. Merged with engine-level media_io_kwargs." }, "mm_processor_kwargs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mm Processor Kwargs", "description": "Additional kwargs to pass to the HF processor." }, "priority": { "type": "integer", "maximum": 9.223372036854776e+18, "minimum": -9.223372036854776e+18, "title": "Priority", "description": "The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.", "default": 0 }, "mm_payload": { "type": "string", "enum": [ "tensors", "none" ], "title": "Mm Payload", "description": "What the render response's `features` carry for multimodal items. 'tensors' serializes the processed tensors into `kwargs_data` and `mm_metadata`. 'none' sets both to null for callers that need only the token layout and item hashes, such as cache-aware routers. Do not send a 'none' response to `/inference/v1/generate` which reads a null `kwargs_data` as every item being cached. Only supported on the render endpoints. Ignored on regular generation endpoints.", "default": "tensors" }, "return_mm_kwargs": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Return Mm Kwargs", "description": "Deprecated alias: false is the same as `mm_payload='none'`. Ignored when `mm_payload` is set.", "deprecated": true }, "cache_salt": { "anyOf": [ { "type": "string", "maxLength": 1024, "minLength": 1 }, { "type": "null" } ], "title": "Cache Salt", "description": "If specified, the prefix cache will be salted with the provided string to prevent an attacker to guess prompts in multi-user environments. The salt should be random, protected from access by 3rd parties, and long enough to be unpredictable (e.g., 43 characters base64-encoded, corresponding to 256 bit)." }, "enable_response_messages": { "type": "boolean", "title": "Enable Response Messages", "description": "Dictates whether or not to return messages as part of the response object. Currently only supported for non-background.", "default": false }, "previous_input_messages": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/openai_harmony__Message" }, { "additionalProperties": true, "type": "object" } ] }, "type": "array" }, { "type": "null" } ], "title": "Previous Input Messages" }, "structured_outputs": { "anyOf": [ { "$ref": "#/$defs/StructuredOutputsParams" }, { "type": "null" } ], "description": "Additional kwargs for structured outputs" }, "repetition_penalty": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Repetition Penalty" }, "seed": { "anyOf": [ { "type": "integer", "maximum": 9.223372036854776e+18, "minimum": -9.223372036854776e+18 }, { "type": "null" } ], "title": "Seed" }, "stop": { "anyOf": [ { "type": "string" }, { "items": { "type": "string" }, "type": "array", "maxItems": 4 }, { "type": "null" } ], "title": "Stop", "default": [] }, "stop_token_ids": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Stop Token Ids", "default": [] }, "ignore_eos": { "type": "boolean", "title": "Ignore Eos", "default": false }, "vllm_xargs": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ] }, "type": "array" } ] }, "type": "object" }, { "type": "null" } ], "title": "Vllm Xargs", "description": "Additional request parameters with (list of) string or numeric values, used by custom extensions." }, "kv_transfer_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Kv Transfer Params", "description": "KVTransfer parameters used for disaggregated serving." }, "ec_transfer_params": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Ec Transfer Params", "description": "ECTransfer parameters used for encoder-cache disaggregated serving." }, "chat_template_kwargs": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Chat Template Kwargs", "description": "Additional keyword args to pass to the chat template renderer. Will be accessible by the template." } }, "additionalProperties": true, "type": "object", "required": [ "input" ], "$defs": { "AcknowledgedSafetyCheck": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "AcknowledgedSafetyCheck", "description": "A pending safety check for the computer call." }, "Action": { "properties": { "commands": { "items": { "type": "string" }, "type": "array", "title": "Commands" }, "max_output_length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Length" }, "timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Timeout Ms" } }, "additionalProperties": true, "type": "object", "required": [ "commands" ], "title": "Action", "description": "The shell commands and limits that describe how to run the tool call." }, "ActionDragPath": { "properties": { "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" } }, "additionalProperties": true, "type": "object", "required": [ "x", "y" ], "title": "ActionDragPath", "description": "An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`." }, "ActionFind": { "properties": { "pattern": { "type": "string", "title": "Pattern" }, "type": { "type": "string", "const": "find_in_page", "title": "Type" }, "url": { "type": "string", "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "pattern", "type", "url" ], "title": "ActionFind", "description": "Action type \"find_in_page\": Searches for a pattern within a loaded page." }, "ActionKeypress": { "properties": { "keys": { "items": { "type": "string" }, "type": "array", "title": "Keys" }, "type": { "type": "string", "const": "keypress", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "keys", "type" ], "title": "ActionKeypress", "description": "A collection of keypresses the model would like to perform." }, "ActionScreenshot": { "properties": { "type": { "type": "string", "const": "screenshot", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ActionScreenshot", "description": "A screenshot action." }, "ActionSearchSource": { "properties": { "type": { "type": "string", "const": "url", "title": "Type" }, "url": { "type": "string", "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "type", "url" ], "title": "ActionSearchSource", "description": "A source used in the search." }, "ActionType": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "type", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "ActionType", "description": "An action to type in text." }, "ActionWait": { "properties": { "type": { "type": "string", "const": "wait", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ActionWait", "description": "A wait action." }, "AnnotationContainerFileCitation": { "properties": { "container_id": { "type": "string", "title": "Container Id" }, "end_index": { "type": "integer", "title": "End Index" }, "file_id": { "type": "string", "title": "File Id" }, "filename": { "type": "string", "title": "Filename" }, "start_index": { "type": "integer", "title": "Start Index" }, "type": { "type": "string", "const": "container_file_citation", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "container_id", "end_index", "file_id", "filename", "start_index", "type" ], "title": "AnnotationContainerFileCitation", "description": "A citation for a container file used to generate a model response." }, "AnnotationFileCitation": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "filename": { "type": "string", "title": "Filename" }, "index": { "type": "integer", "title": "Index" }, "type": { "type": "string", "const": "file_citation", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "file_id", "filename", "index", "type" ], "title": "AnnotationFileCitation", "description": "A citation to a file." }, "AnnotationFilePath": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "index": { "type": "integer", "title": "Index" }, "type": { "type": "string", "const": "file_path", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "file_id", "index", "type" ], "title": "AnnotationFilePath", "description": "A path to a file." }, "AnnotationURLCitation": { "properties": { "end_index": { "type": "integer", "title": "End Index" }, "start_index": { "type": "integer", "title": "Start Index" }, "title": { "type": "string", "title": "Title" }, "type": { "type": "string", "const": "url_citation", "title": "Type" }, "url": { "type": "string", "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "end_index", "start_index", "title", "type", "url" ], "title": "AnnotationURLCitation", "description": "A citation for a web resource used to generate a model response." }, "ApplyPatchCall": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "operation": { "anyOf": [ { "$ref": "#/$defs/ApplyPatchCallOperationCreateFile" }, { "$ref": "#/$defs/ApplyPatchCallOperationDeleteFile" }, { "$ref": "#/$defs/ApplyPatchCallOperationUpdateFile" } ], "title": "Operation" }, "status": { "type": "string", "enum": [ "in_progress", "completed" ], "title": "Status" }, "type": { "type": "string", "const": "apply_patch_call", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/ApplyPatchCallCallerDirect" }, { "$ref": "#/$defs/ApplyPatchCallCallerProgram" }, { "type": "null" } ], "title": "Caller" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "operation", "status", "type" ], "title": "ApplyPatchCall", "description": "A tool call representing a request to create, delete, or update files using diff patches." }, "ApplyPatchCallCallerDirect": { "properties": { "type": { "type": "string", "const": "direct", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ApplyPatchCallCallerDirect" }, "ApplyPatchCallCallerProgram": { "properties": { "caller_id": { "type": "string", "title": "Caller Id" }, "type": { "type": "string", "const": "program", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "caller_id", "type" ], "title": "ApplyPatchCallCallerProgram" }, "ApplyPatchCallOperationCreateFile": { "properties": { "diff": { "type": "string", "title": "Diff" }, "path": { "type": "string", "title": "Path" }, "type": { "type": "string", "const": "create_file", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "diff", "path", "type" ], "title": "ApplyPatchCallOperationCreateFile", "description": "Instruction for creating a new file via the apply_patch tool." }, "ApplyPatchCallOperationDeleteFile": { "properties": { "path": { "type": "string", "title": "Path" }, "type": { "type": "string", "const": "delete_file", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "path", "type" ], "title": "ApplyPatchCallOperationDeleteFile", "description": "Instruction for deleting an existing file via the apply_patch tool." }, "ApplyPatchCallOperationUpdateFile": { "properties": { "diff": { "type": "string", "title": "Diff" }, "path": { "type": "string", "title": "Path" }, "type": { "type": "string", "const": "update_file", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "diff", "path", "type" ], "title": "ApplyPatchCallOperationUpdateFile", "description": "Instruction for updating an existing file via the apply_patch tool." }, "ApplyPatchCallOutput": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "status": { "type": "string", "enum": [ "completed", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "apply_patch_call_output", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/ApplyPatchCallOutputCallerDirect" }, { "$ref": "#/$defs/ApplyPatchCallOutputCallerProgram" }, { "type": "null" } ], "title": "Caller" }, "output": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "status", "type" ], "title": "ApplyPatchCallOutput", "description": "The streamed output emitted by an apply patch tool call." }, "ApplyPatchCallOutputCallerDirect": { "properties": { "type": { "type": "string", "const": "direct", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ApplyPatchCallOutputCallerDirect" }, "ApplyPatchCallOutputCallerProgram": { "properties": { "caller_id": { "type": "string", "title": "Caller Id" }, "type": { "type": "string", "const": "program", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "caller_id", "type" ], "title": "ApplyPatchCallOutputCallerProgram" }, "ApplyPatchTool": { "properties": { "type": { "type": "string", "const": "apply_patch", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ApplyPatchTool", "description": "Allows the assistant to create, delete, or update files using unified diffs." }, "ApplyPatchToolParam": { "properties": { "type": { "type": "string", "const": "apply_patch", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ApplyPatchToolParam", "description": "Allows the assistant to create, delete, or update files using unified diffs." }, "Author": { "properties": { "role": { "$ref": "#/$defs/Role" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "required": [ "role" ], "title": "Author" }, "CallerDirect": { "properties": { "type": { "type": "string", "const": "direct", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "CallerDirect" }, "CallerProgram": { "properties": { "caller_id": { "type": "string", "title": "Caller Id" }, "type": { "type": "string", "const": "program", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "caller_id", "type" ], "title": "CallerProgram" }, "CompactionTrigger": { "properties": { "type": { "type": "string", "const": "compaction_trigger", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "CompactionTrigger", "description": "Compacts the current context. Must be the final input item." }, "ComputerCallOutput": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "output": { "$ref": "#/$defs/ResponseComputerToolCallOutputScreenshotParam" }, "type": { "type": "string", "const": "computer_call_output", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "acknowledged_safety_checks": { "anyOf": [ { "items": { "$ref": "#/$defs/ComputerCallOutputAcknowledgedSafetyCheck" }, "type": "array" }, { "type": "null" } ], "title": "Acknowledged Safety Checks" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type" ], "title": "ComputerCallOutput", "description": "The output of a computer tool call." }, "ComputerCallOutputAcknowledgedSafetyCheck": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "ComputerCallOutputAcknowledgedSafetyCheck", "description": "A pending safety check for the computer call." }, "ComputerTool": { "properties": { "type": { "type": "string", "const": "computer", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ComputerTool", "description": "A tool that controls a virtual computer.\n\nLearn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use)." }, "ComputerToolParam": { "properties": { "type": { "type": "string", "const": "computer", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ComputerToolParam", "description": "A tool that controls a virtual computer.\n\nLearn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use)." }, "ComputerUsePreviewTool": { "properties": { "display_height": { "type": "integer", "title": "Display Height" }, "display_width": { "type": "integer", "title": "Display Width" }, "environment": { "type": "string", "enum": [ "windows", "mac", "linux", "ubuntu", "browser" ], "title": "Environment" }, "type": { "type": "string", "const": "computer_use_preview", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "display_height", "display_width", "environment", "type" ], "title": "ComputerUsePreviewTool", "description": "A tool that controls a virtual computer.\n\nLearn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use)." }, "ComputerUsePreviewToolParam": { "properties": { "display_height": { "type": "integer", "title": "Display Height" }, "display_width": { "type": "integer", "title": "Display Width" }, "environment": { "type": "string", "enum": [ "windows", "mac", "linux", "ubuntu", "browser" ], "title": "Environment" }, "type": { "type": "string", "const": "computer_use_preview", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "display_height", "display_width", "environment", "type" ], "title": "ComputerUsePreviewToolParam", "description": "A tool that controls a virtual computer.\n\nLearn more about the [computer tool](https://developers.openai.com/api/docs/guides/tools-computer-use)." }, "ContainerAuto": { "properties": { "type": { "type": "string", "const": "container_auto", "title": "Type" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "File Ids" }, "memory_limit": { "anyOf": [ { "type": "string", "enum": [ "1g", "4g", "16g", "64g" ] }, { "type": "null" } ], "title": "Memory Limit" }, "network_policy": { "anyOf": [ { "$ref": "#/$defs/ContainerNetworkPolicyDisabled" }, { "$ref": "#/$defs/ContainerNetworkPolicyAllowlist" }, { "type": "null" } ], "title": "Network Policy" }, "skills": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/SkillReference" }, { "$ref": "#/$defs/InlineSkill" } ] }, "type": "array" }, { "type": "null" } ], "title": "Skills" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ContainerAuto" }, "ContainerAutoParam": { "properties": { "type": { "type": "string", "const": "container_auto", "title": "Type" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids" }, "memory_limit": { "anyOf": [ { "type": "string", "enum": [ "1g", "4g", "16g", "64g" ] }, { "type": "null" } ], "title": "Memory Limit" }, "network_policy": { "anyOf": [ { "$ref": "#/$defs/ContainerNetworkPolicyDisabledParam" }, { "$ref": "#/$defs/ContainerNetworkPolicyAllowlistParam" } ], "title": "Network Policy" }, "skills": { "items": { "anyOf": [ { "$ref": "#/$defs/SkillReferenceParam" }, { "$ref": "#/$defs/InlineSkillParam" } ] }, "type": "array", "title": "Skills" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ContainerAutoParam" }, "ContainerNetworkPolicyAllowlist": { "properties": { "allowed_domains": { "items": { "type": "string" }, "type": "array", "title": "Allowed Domains" }, "type": { "type": "string", "const": "allowlist", "title": "Type" }, "domain_secrets": { "anyOf": [ { "items": { "$ref": "#/$defs/ContainerNetworkPolicyDomainSecret" }, "type": "array" }, { "type": "null" } ], "title": "Domain Secrets" } }, "additionalProperties": true, "type": "object", "required": [ "allowed_domains", "type" ], "title": "ContainerNetworkPolicyAllowlist" }, "ContainerNetworkPolicyAllowlistParam": { "properties": { "allowed_domains": { "items": { "type": "string" }, "type": "array", "title": "Allowed Domains" }, "type": { "type": "string", "const": "allowlist", "title": "Type" }, "domain_secrets": { "items": { "$ref": "#/$defs/ContainerNetworkPolicyDomainSecretParam" }, "type": "array", "title": "Domain Secrets" } }, "additionalProperties": true, "type": "object", "required": [ "allowed_domains", "type" ], "title": "ContainerNetworkPolicyAllowlistParam" }, "ContainerNetworkPolicyDisabled": { "properties": { "type": { "type": "string", "const": "disabled", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ContainerNetworkPolicyDisabled" }, "ContainerNetworkPolicyDisabledParam": { "properties": { "type": { "type": "string", "const": "disabled", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ContainerNetworkPolicyDisabledParam" }, "ContainerNetworkPolicyDomainSecret": { "properties": { "domain": { "type": "string", "title": "Domain" }, "name": { "type": "string", "title": "Name" }, "value": { "type": "string", "title": "Value" } }, "additionalProperties": true, "type": "object", "required": [ "domain", "name", "value" ], "title": "ContainerNetworkPolicyDomainSecret" }, "ContainerNetworkPolicyDomainSecretParam": { "properties": { "domain": { "type": "string", "title": "Domain" }, "name": { "type": "string", "title": "Name" }, "value": { "type": "string", "title": "Value" } }, "additionalProperties": true, "type": "object", "required": [ "domain", "name", "value" ], "title": "ContainerNetworkPolicyDomainSecretParam" }, "ContainerReference": { "properties": { "container_id": { "type": "string", "title": "Container Id" }, "type": { "type": "string", "const": "container_reference", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "container_id", "type" ], "title": "ContainerReference" }, "ContainerReferenceParam": { "properties": { "container_id": { "type": "string", "title": "Container Id" }, "type": { "type": "string", "const": "container_reference", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "container_id", "type" ], "title": "ContainerReferenceParam" }, "CustomTool": { "properties": { "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "custom", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "async": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Async" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Defer Loading" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "format": { "anyOf": [ { "$ref": "#/$defs/Text" }, { "$ref": "#/$defs/Grammar" }, { "type": "null" } ], "title": "Format" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "CustomTool", "description": "A custom tool that processes input using a specified format.\n\nLearn more about [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)" }, "CustomToolParam": { "properties": { "async": { "type": "boolean", "title": "Async" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "custom", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "defer_loading": { "type": "boolean", "title": "Defer Loading" }, "description": { "type": "string", "title": "Description" }, "format": { "anyOf": [ { "$ref": "#/$defs/Text" }, { "$ref": "#/$defs/Grammar" } ], "title": "Format" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "CustomToolParam", "description": "A custom tool that processes input using a specified format.\n\nLearn more about [custom tools](https://developers.openai.com/api/docs/guides/function-calling#custom-tools)" }, "DragPath": { "properties": { "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" } }, "additionalProperties": true, "type": "object", "required": [ "x", "y" ], "title": "DragPath", "description": "An x/y coordinate pair, e.g. `{ x: 100, y: 200 }`." }, "EasyInputMessageParam": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputTextParam" }, { "$ref": "#/$defs/ResponseInputImageParam" }, { "$ref": "#/$defs/ResponseInputFileParam" } ] }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "enum": [ "user", "assistant", "system", "developer" ], "title": "Role" }, "phase": { "anyOf": [ { "type": "string", "enum": [ "commentary", "final_answer" ] }, { "type": "null" } ], "title": "Phase" }, "type": { "type": "string", "const": "message", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "content", "role" ], "title": "EasyInputMessageParam", "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role. Messages with the\n`assistant` role are presumed to have been generated by the model in previous\ninteractions." }, "FileSearchTool": { "properties": { "type": { "type": "string", "const": "file_search", "title": "Type" }, "vector_store_ids": { "items": { "type": "string" }, "type": "array", "title": "Vector Store Ids" }, "filters": { "anyOf": [ { "$ref": "#/$defs/openai__types__shared__comparison_filter__ComparisonFilter" }, { "$ref": "#/$defs/openai__types__shared__compound_filter__CompoundFilter" }, { "type": "null" } ], "title": "Filters" }, "max_num_results": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Num Results" }, "ranking_options": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__file_search_tool__RankingOptions" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type", "vector_store_ids" ], "title": "FileSearchTool", "description": "A tool that searches for relevant content from uploaded files.\n\nLearn more about the [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search)." }, "FileSearchToolParam": { "properties": { "type": { "type": "string", "const": "file_search", "title": "Type" }, "vector_store_ids": { "items": { "type": "string" }, "type": "array", "title": "Vector Store Ids" }, "filters": { "anyOf": [ { "$ref": "#/$defs/openai__types__shared_params__comparison_filter__ComparisonFilter" }, { "$ref": "#/$defs/openai__types__shared_params__compound_filter__CompoundFilter" }, { "type": "null" } ], "title": "Filters" }, "max_num_results": { "type": "integer", "title": "Max Num Results" }, "ranking_options": { "$ref": "#/$defs/openai__types__responses__file_search_tool_param__RankingOptions" } }, "additionalProperties": true, "type": "object", "required": [ "type", "vector_store_ids" ], "title": "FileSearchToolParam", "description": "A tool that searches for relevant content from uploaded files.\n\nLearn more about the [file search tool](https://developers.openai.com/api/docs/guides/tools-file-search)." }, "FunctionCallOutput": { "properties": { "output": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputTextContentParam" }, { "$ref": "#/$defs/ResponseInputImageContentParam" }, { "$ref": "#/$defs/ResponseInputFileContentParam" } ] }, "type": "array" } ], "title": "Output" }, "type": { "type": "string", "const": "function_call_output", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/FunctionCallOutputCallerDirect" }, { "$ref": "#/$defs/FunctionCallOutputCallerProgram" }, { "type": "null" } ], "title": "Caller" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Namespace" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "output", "type" ], "title": "FunctionCallOutput", "description": "The output of a function tool call." }, "FunctionCallOutputCallerDirect": { "properties": { "type": { "type": "string", "const": "direct", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "FunctionCallOutputCallerDirect" }, "FunctionCallOutputCallerProgram": { "properties": { "caller_id": { "type": "string", "title": "Caller Id" }, "type": { "type": "string", "const": "program", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "caller_id", "type" ], "title": "FunctionCallOutputCallerProgram" }, "FunctionShellTool": { "properties": { "type": { "type": "string", "const": "shell", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "environment": { "anyOf": [ { "$ref": "#/$defs/ContainerAuto" }, { "$ref": "#/$defs/LocalEnvironment" }, { "$ref": "#/$defs/ContainerReference" }, { "type": "null" } ], "title": "Environment" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "FunctionShellTool", "description": "A tool that allows the model to execute shell commands." }, "FunctionShellToolParam": { "properties": { "type": { "type": "string", "const": "shell", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "environment": { "anyOf": [ { "$ref": "#/$defs/ContainerAutoParam" }, { "$ref": "#/$defs/LocalEnvironmentParam" }, { "$ref": "#/$defs/ContainerReferenceParam" }, { "type": "null" } ], "title": "Environment" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "FunctionShellToolParam", "description": "A tool that allows the model to execute shell commands." }, "FunctionTool": { "properties": { "name": { "type": "string", "title": "Name" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" }, "type": { "type": "string", "const": "function", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "async": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Async" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Defer Loading" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "FunctionTool", "description": "Defines a function in your own code the model can choose to call.\n\nLearn more about [function calling](https://developers.openai.com/api/docs/guides/function-calling)." }, "FunctionToolParam": { "properties": { "async": { "type": "boolean", "title": "Async" }, "name": { "type": "string", "title": "Name" }, "parameters": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" }, "type": { "type": "string", "const": "function", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "defer_loading": { "type": "boolean", "title": "Defer Loading" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema" } }, "additionalProperties": true, "type": "object", "required": [ "name", "parameters", "strict", "type" ], "title": "FunctionToolParam", "description": "Defines a function in your own code the model can choose to call.\n\nLearn more about [function calling](https://developers.openai.com/api/docs/guides/function-calling)." }, "Grammar": { "properties": { "definition": { "type": "string", "title": "Definition" }, "syntax": { "type": "string", "enum": [ "lark", "regex" ], "title": "Syntax" }, "type": { "type": "string", "const": "grammar", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "definition", "syntax", "type" ], "title": "Grammar", "description": "A grammar defined by the user." }, "HTTPError": { "properties": { "code": { "type": "integer", "title": "Code" }, "message": { "type": "string", "title": "Message" }, "type": { "type": "string", "const": "http_error", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "code", "message", "type" ], "title": "HTTPError" }, "ImageGenerationCallErrorModerationDetails": { "properties": { "categories": { "items": { "type": "string" }, "type": "array", "title": "Categories" }, "moderation_stage": { "type": "string", "enum": [ "input", "output", "unknown" ], "title": "Moderation Stage" } }, "additionalProperties": true, "type": "object", "required": [ "categories", "moderation_stage" ], "title": "ImageGenerationCallErrorModerationDetails", "description": "Public details for a `moderation_blocked` error, when available." }, "InlineSkill": { "properties": { "description": { "type": "string", "title": "Description" }, "name": { "type": "string", "title": "Name" }, "source": { "$ref": "#/$defs/InlineSkillSource" }, "type": { "type": "string", "const": "inline", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "source", "type" ], "title": "InlineSkill" }, "InlineSkillParam": { "properties": { "description": { "type": "string", "title": "Description" }, "name": { "type": "string", "title": "Name" }, "source": { "$ref": "#/$defs/InlineSkillSourceParam" }, "type": { "type": "string", "const": "inline", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "source", "type" ], "title": "InlineSkillParam" }, "InlineSkillSource": { "properties": { "data": { "type": "string", "title": "Data" }, "media_type": { "type": "string", "const": "application/zip", "title": "Media Type" }, "type": { "type": "string", "const": "base64", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "data", "media_type", "type" ], "title": "InlineSkillSource", "description": "Inline skill payload" }, "InlineSkillSourceParam": { "properties": { "data": { "type": "string", "title": "Data" }, "media_type": { "type": "string", "const": "application/zip", "title": "Media Type" }, "type": { "type": "string", "const": "base64", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "data", "media_type", "type" ], "title": "InlineSkillSourceParam", "description": "Inline skill payload" }, "ItemReference": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "anyOf": [ { "type": "string", "const": "item_reference" }, { "type": "null" } ], "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "ItemReference", "description": "An internal identifier for an item to reference." }, "Keypress": { "properties": { "keys": { "items": { "type": "string" }, "type": "array", "title": "Keys" }, "type": { "type": "string", "const": "keypress", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "keys", "type" ], "title": "Keypress", "description": "A collection of keypresses the model would like to perform." }, "LocalEnvironment": { "properties": { "type": { "type": "string", "const": "local", "title": "Type" }, "skills": { "anyOf": [ { "items": { "$ref": "#/$defs/LocalSkill" }, "type": "array" }, { "type": "null" } ], "title": "Skills" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "LocalEnvironment" }, "LocalEnvironmentParam": { "properties": { "type": { "type": "string", "const": "local", "title": "Type" }, "skills": { "items": { "$ref": "#/$defs/LocalSkillParam" }, "type": "array", "title": "Skills" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "LocalEnvironmentParam" }, "LocalShell": { "properties": { "type": { "type": "string", "const": "local_shell", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "LocalShell", "description": "A tool that allows the model to execute shell commands in a local environment." }, "LocalSkill": { "properties": { "description": { "type": "string", "title": "Description" }, "name": { "type": "string", "title": "Name" }, "path": { "type": "string", "title": "Path" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "path" ], "title": "LocalSkill" }, "LocalSkillParam": { "properties": { "description": { "type": "string", "title": "Description" }, "name": { "type": "string", "title": "Name" }, "path": { "type": "string", "title": "Path" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "path" ], "title": "LocalSkillParam" }, "Logprob": { "properties": { "token": { "type": "string", "title": "Token" }, "bytes": { "items": { "type": "integer" }, "type": "array", "title": "Bytes" }, "logprob": { "type": "number", "title": "Logprob" }, "top_logprobs": { "items": { "$ref": "#/$defs/LogprobTopLogprob" }, "type": "array", "title": "Top Logprobs" } }, "additionalProperties": true, "type": "object", "required": [ "token", "bytes", "logprob", "top_logprobs" ], "title": "Logprob", "description": "The log probability of a token." }, "LogprobTopLogprob": { "properties": { "token": { "type": "string", "title": "Token" }, "bytes": { "items": { "type": "integer" }, "type": "array", "title": "Bytes" }, "logprob": { "type": "number", "title": "Logprob" } }, "additionalProperties": true, "type": "object", "required": [ "token", "bytes", "logprob" ], "title": "LogprobTopLogprob", "description": "The top log probability of a token." }, "McpApprovalRequest": { "properties": { "id": { "type": "string", "title": "Id" }, "arguments": { "type": "string", "title": "Arguments" }, "name": { "type": "string", "title": "Name" }, "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp_approval_request", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "arguments", "name", "server_label", "type" ], "title": "McpApprovalRequest", "description": "A request for human approval of a tool invocation." }, "McpProtocolError": { "properties": { "code": { "type": "integer", "title": "Code" }, "message": { "type": "string", "title": "Message" }, "type": { "type": "string", "const": "mcp_protocol_error", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "code", "message", "type" ], "title": "McpProtocolError" }, "McpToolExecutionError": { "properties": { "content": { "title": "Content" }, "type": { "type": "string", "const": "mcp_tool_execution_error", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "content", "type" ], "title": "McpToolExecutionError" }, "NamespaceTool": { "properties": { "description": { "type": "string", "title": "Description" }, "name": { "type": "string", "title": "Name" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__namespace_tool__ToolFunction" }, { "$ref": "#/$defs/CustomTool" } ] }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "namespace", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "tools", "type" ], "title": "NamespaceTool", "description": "Groups function/custom tools under a shared namespace." }, "NamespaceToolParam": { "properties": { "description": { "type": "string", "title": "Description" }, "name": { "type": "string", "title": "Name" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__namespace_tool_param__ToolFunction" }, { "$ref": "#/$defs/CustomToolParam" } ] }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "namespace", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "tools", "type" ], "title": "NamespaceToolParam", "description": "Groups function/custom tools under a shared namespace." }, "OperationCreateFile": { "properties": { "diff": { "type": "string", "title": "Diff" }, "path": { "type": "string", "title": "Path" }, "type": { "type": "string", "const": "create_file", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "diff", "path", "type" ], "title": "OperationCreateFile", "description": "Instruction describing how to create a file via the apply_patch tool." }, "OperationDeleteFile": { "properties": { "path": { "type": "string", "title": "Path" }, "type": { "type": "string", "const": "delete_file", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "path", "type" ], "title": "OperationDeleteFile", "description": "Instruction describing how to delete a file via the apply_patch tool." }, "OperationUpdateFile": { "properties": { "diff": { "type": "string", "title": "Diff" }, "path": { "type": "string", "title": "Path" }, "type": { "type": "string", "const": "update_file", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "diff", "path", "type" ], "title": "OperationUpdateFile", "description": "Instruction describing how to update a file via the apply_patch tool." }, "OutcomeExit": { "properties": { "exit_code": { "type": "integer", "title": "Exit Code" }, "type": { "type": "string", "const": "exit", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "exit_code", "type" ], "title": "OutcomeExit", "description": "Indicates that the shell commands finished and returned an exit code." }, "OutcomeTimeout": { "properties": { "type": { "type": "string", "const": "timeout", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "OutcomeTimeout", "description": "Indicates that the shell call exceeded its configured time limit." }, "Output": { "properties": { "outcome": { "anyOf": [ { "$ref": "#/$defs/OutputOutcomeTimeout" }, { "$ref": "#/$defs/OutputOutcomeExit" } ], "title": "Outcome" }, "stderr": { "type": "string", "title": "Stderr" }, "stdout": { "type": "string", "title": "Stdout" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "outcome", "stderr", "stdout" ], "title": "Output", "description": "The content of a shell tool call output that was emitted." }, "OutputImage": { "properties": { "type": { "type": "string", "const": "image", "title": "Type" }, "url": { "type": "string", "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "type", "url" ], "title": "OutputImage", "description": "The image output from the code interpreter." }, "OutputLogs": { "properties": { "logs": { "type": "string", "title": "Logs" }, "type": { "type": "string", "const": "logs", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "logs", "type" ], "title": "OutputLogs", "description": "The logs output from the code interpreter." }, "OutputOutcomeExit": { "properties": { "exit_code": { "type": "integer", "title": "Exit Code" }, "type": { "type": "string", "const": "exit", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "exit_code", "type" ], "title": "OutputOutcomeExit", "description": "Indicates that the shell commands finished and returned an exit code." }, "OutputOutcomeTimeout": { "properties": { "type": { "type": "string", "const": "timeout", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "OutputOutcomeTimeout", "description": "Indicates that the shell call exceeded its configured time limit." }, "Program": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "code": { "type": "string", "title": "Code" }, "fingerprint": { "type": "string", "title": "Fingerprint" }, "type": { "type": "string", "const": "program", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "code", "fingerprint", "type" ], "title": "Program" }, "ProgramOutput": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "result": { "type": "string", "title": "Result" }, "status": { "type": "string", "enum": [ "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "program_output", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "result", "status", "type" ], "title": "ProgramOutput" }, "ProgrammaticToolCalling": { "properties": { "type": { "type": "string", "const": "programmatic_tool_calling", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ProgrammaticToolCalling" }, "PromptCacheBreakpoint": { "properties": { "mode": { "type": "string", "const": "explicit", "title": "Mode" } }, "additionalProperties": true, "type": "object", "required": [ "mode" ], "title": "PromptCacheBreakpoint", "description": "Marks the exact end of a reusable prompt prefix.\n\nThe breakpoint inherits its TTL from the request's `prompt_cache_options.ttl`; the boundary is not rounded to a token block." }, "RankingOptionsHybridSearch": { "properties": { "embedding_weight": { "type": "number", "title": "Embedding Weight" }, "text_weight": { "type": "number", "title": "Text Weight" } }, "additionalProperties": true, "type": "object", "required": [ "embedding_weight", "text_weight" ], "title": "RankingOptionsHybridSearch", "description": "Weights that control how reciprocal rank fusion balances semantic embedding matches versus sparse keyword matches when hybrid search is enabled." }, "ResponseApplyPatchToolCall": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "operation": { "anyOf": [ { "$ref": "#/$defs/OperationCreateFile" }, { "$ref": "#/$defs/OperationDeleteFile" }, { "$ref": "#/$defs/OperationUpdateFile" } ], "title": "Operation" }, "status": { "type": "string", "enum": [ "in_progress", "completed" ], "title": "Status" }, "type": { "type": "string", "const": "apply_patch_call", "title": "Type" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "operation", "status", "type" ], "title": "ResponseApplyPatchToolCall", "description": "A tool call that applies file diffs by creating, deleting, or updating files." }, "ResponseApplyPatchToolCallOutput": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "status": { "type": "string", "enum": [ "completed", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "apply_patch_call_output", "title": "Type" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "output": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "status", "type" ], "title": "ResponseApplyPatchToolCallOutput", "description": "The output emitted by an apply patch tool call." }, "ResponseCodeInterpreterToolCall": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "container_id": { "type": "string", "title": "Container Id" }, "outputs": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/OutputLogs" }, { "$ref": "#/$defs/OutputImage" } ] }, "type": "array" }, { "type": "null" } ], "title": "Outputs" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "interpreting", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "code_interpreter_call", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "container_id", "status", "type" ], "title": "ResponseCodeInterpreterToolCall", "description": "A tool call to run code." }, "ResponseCodeInterpreterToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "container_id": { "type": "string", "title": "Container Id" }, "outputs": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/OutputLogs" }, { "$ref": "#/$defs/OutputImage" } ] }, "type": "array" }, { "type": "null" } ], "title": "Outputs" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "interpreting", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "code_interpreter_call", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "code", "container_id", "outputs", "status", "type" ], "title": "ResponseCodeInterpreterToolCallParam", "description": "A tool call to run code." }, "ResponseCompactionItem": { "properties": { "id": { "type": "string", "title": "Id" }, "encrypted_content": { "type": "string", "title": "Encrypted Content" }, "type": { "type": "string", "const": "compaction", "title": "Type" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "id", "encrypted_content", "type" ], "title": "ResponseCompactionItem", "description": "A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact)." }, "ResponseCompactionItemParamParam": { "properties": { "encrypted_content": { "type": "string", "title": "Encrypted Content" }, "type": { "type": "string", "const": "compaction", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "additionalProperties": true, "type": "object", "required": [ "encrypted_content", "type" ], "title": "ResponseCompactionItemParamParam", "description": "A compaction item generated by the [`v1/responses/compact` API](https://developers.openai.com/api/reference/resources/responses/methods/compact)." }, "ResponseComputerToolCall": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "pending_safety_checks": { "items": { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call__PendingSafetyCheck" }, "type": "array", "title": "Pending Safety Checks" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "computer_call", "title": "Type" }, "action": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call__ActionClick" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call__ActionDoubleClick" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call__ActionDrag" }, { "$ref": "#/$defs/ActionKeypress" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call__ActionMove" }, { "$ref": "#/$defs/ActionScreenshot" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call__ActionScroll" }, { "$ref": "#/$defs/ActionType" }, { "$ref": "#/$defs/ActionWait" }, { "type": "null" } ], "title": "Action" }, "actions": { "anyOf": [ { "items": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__computer_action__Click" }, { "$ref": "#/$defs/openai__types__responses__computer_action__DoubleClick" }, { "$ref": "#/$defs/openai__types__responses__computer_action__Drag" }, { "$ref": "#/$defs/Keypress" }, { "$ref": "#/$defs/openai__types__responses__computer_action__Move" }, { "$ref": "#/$defs/Screenshot" }, { "$ref": "#/$defs/openai__types__responses__computer_action__Scroll" }, { "$ref": "#/$defs/Type" }, { "$ref": "#/$defs/Wait" } ] }, "type": "array" }, { "type": "null" } ], "title": "Actions" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "pending_safety_checks", "status", "type" ], "title": "ResponseComputerToolCall", "description": "A tool call to a computer use tool.\n\nSee the\n[computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information." }, "ResponseComputerToolCallOutputItem": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "output": { "$ref": "#/$defs/ResponseComputerToolCallOutputScreenshot" }, "status": { "type": "string", "enum": [ "completed", "incomplete", "failed", "in_progress" ], "title": "Status" }, "type": { "type": "string", "const": "computer_call_output", "title": "Type" }, "acknowledged_safety_checks": { "anyOf": [ { "items": { "$ref": "#/$defs/AcknowledgedSafetyCheck" }, "type": "array" }, { "type": "null" } ], "title": "Acknowledged Safety Checks" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "output", "status", "type" ], "title": "ResponseComputerToolCallOutputItem" }, "ResponseComputerToolCallOutputScreenshot": { "properties": { "type": { "type": "string", "const": "computer_screenshot", "title": "Type" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseComputerToolCallOutputScreenshot", "description": "A computer screenshot image used with the computer use tool." }, "ResponseComputerToolCallOutputScreenshotParam": { "properties": { "type": { "type": "string", "const": "computer_screenshot", "title": "Type" }, "file_id": { "type": "string", "title": "File Id" }, "image_url": { "type": "string", "title": "Image Url" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseComputerToolCallOutputScreenshotParam", "description": "A computer screenshot image used with the computer use tool." }, "ResponseComputerToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "pending_safety_checks": { "items": { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call_param__PendingSafetyCheck" }, "type": "array", "title": "Pending Safety Checks" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "computer_call", "title": "Type" }, "action": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call_param__ActionClick" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call_param__ActionDoubleClick" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call_param__ActionDrag" }, { "$ref": "#/$defs/ActionKeypress" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call_param__ActionMove" }, { "$ref": "#/$defs/ActionScreenshot" }, { "$ref": "#/$defs/openai__types__responses__response_computer_tool_call_param__ActionScroll" }, { "$ref": "#/$defs/ActionType" }, { "$ref": "#/$defs/ActionWait" } ], "title": "Action" }, "actions": { "items": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__computer_action_list_param__Click" }, { "$ref": "#/$defs/openai__types__responses__computer_action_list_param__DoubleClick" }, { "$ref": "#/$defs/openai__types__responses__computer_action_list_param__Drag" }, { "$ref": "#/$defs/Keypress" }, { "$ref": "#/$defs/openai__types__responses__computer_action_list_param__Move" }, { "$ref": "#/$defs/Screenshot" }, { "$ref": "#/$defs/openai__types__responses__computer_action_list_param__Scroll" }, { "$ref": "#/$defs/Type" }, { "$ref": "#/$defs/Wait" } ] }, "type": "array", "title": "Actions" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "pending_safety_checks", "status", "type" ], "title": "ResponseComputerToolCallParam", "description": "A tool call to a computer use tool.\n\nSee the\n[computer use guide](https://developers.openai.com/api/docs/guides/tools-computer-use) for more information." }, "ResponseConfigurationUpdateItemParamParam": { "properties": { "type": { "type": "string", "const": "configuration_update", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "reasoning": { "$ref": "#/$defs/openai__types__responses__response_configuration_update_item_param_param__Reasoning" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseConfigurationUpdateItemParamParam", "description": "An update to the conversation's response configuration.\n\nThe configuration\nremains in effect for subsequent responses until it is replaced by another\nconfiguration update." }, "ResponseContainerReference": { "properties": { "container_id": { "type": "string", "title": "Container Id" }, "type": { "type": "string", "const": "container_reference", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "container_id", "type" ], "title": "ResponseContainerReference", "description": "Represents a container created with /v1/containers." }, "ResponseCustomToolCall": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "input": { "type": "string", "title": "Input" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "custom_tool_call", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "async": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Async" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Namespace" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "input", "name", "type" ], "title": "ResponseCustomToolCall", "description": "A call to a custom tool created by the model." }, "ResponseCustomToolCallOutputItem": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "output": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputText" }, { "$ref": "#/$defs/ResponseInputImage" }, { "$ref": "#/$defs/ResponseInputFile" } ] }, "type": "array" } ], "title": "Output" }, "type": { "type": "string", "const": "custom_tool_call_output", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type", "id", "status" ], "title": "ResponseCustomToolCallOutputItem", "description": "The output of a custom tool call from your code, being sent back to the model." }, "ResponseCustomToolCallOutputParam": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "output": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputTextParam" }, { "$ref": "#/$defs/ResponseInputImageParam" }, { "$ref": "#/$defs/ResponseInputFileParam" } ] }, "type": "array" } ], "title": "Output" }, "type": { "type": "string", "const": "custom_tool_call_output", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type" ], "title": "ResponseCustomToolCallOutputParam", "description": "The output of a custom tool call from your code, being sent back to the model." }, "ResponseCustomToolCallParam": { "properties": { "async": { "type": "boolean", "title": "Async" }, "call_id": { "type": "string", "title": "Call Id" }, "input": { "type": "string", "title": "Input" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "custom_tool_call", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "namespace": { "type": "string", "title": "Namespace" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "input", "name", "type" ], "title": "ResponseCustomToolCallParam", "description": "A call to a custom tool created by the model." }, "ResponseFileSearchToolCall": { "properties": { "id": { "type": "string", "title": "Id" }, "queries": { "items": { "type": "string" }, "type": "array", "title": "Queries" }, "status": { "type": "string", "enum": [ "in_progress", "searching", "completed", "incomplete", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "file_search_call", "title": "Type" }, "results": { "anyOf": [ { "items": { "$ref": "#/$defs/openai__types__responses__response_file_search_tool_call__Result" }, "type": "array" }, { "type": "null" } ], "title": "Results" } }, "additionalProperties": true, "type": "object", "required": [ "id", "queries", "status", "type" ], "title": "ResponseFileSearchToolCall", "description": "The results of a file search tool call.\n\nSee the\n[file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information." }, "ResponseFileSearchToolCallParam": { "properties": { "id": { "type": "string", "title": "Id" }, "queries": { "items": { "type": "string" }, "type": "array", "title": "Queries" }, "status": { "type": "string", "enum": [ "in_progress", "searching", "completed", "incomplete", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "file_search_call", "title": "Type" }, "results": { "anyOf": [ { "items": { "$ref": "#/$defs/openai__types__responses__response_file_search_tool_call_param__Result" }, "type": "array" }, { "type": "null" } ], "title": "Results" } }, "additionalProperties": true, "type": "object", "required": [ "id", "queries", "status", "type" ], "title": "ResponseFileSearchToolCallParam", "description": "The results of a file search tool call.\n\nSee the\n[file search guide](https://developers.openai.com/api/docs/guides/tools-file-search) for more information." }, "ResponseFormatJSONObject": { "properties": { "type": { "type": "string", "const": "json_object", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseFormatJSONObject", "description": "JSON object response format.\n\nAn older method of generating JSON responses.\nUsing `json_schema` is recommended for models that support it. Note that the\nmodel will not generate JSON without a system or user message instructing it\nto do so." }, "ResponseFormatText": { "properties": { "type": { "type": "string", "const": "text", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseFormatText", "description": "Default response format. Used to generate text responses." }, "ResponseFormatTextJSONSchemaConfig": { "properties": { "name": { "type": "string", "title": "Name" }, "schema": { "additionalProperties": true, "type": "object", "title": "Schema" }, "type": { "type": "string", "const": "json_schema", "title": "Type" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "additionalProperties": true, "type": "object", "required": [ "name", "schema", "type" ], "title": "ResponseFormatTextJSONSchemaConfig", "description": "JSON Schema response format.\n\nUsed to generate structured JSON responses.\nLearn more about [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)." }, "ResponseFunctionShellCallOutputContentParam": { "properties": { "outcome": { "anyOf": [ { "$ref": "#/$defs/OutcomeTimeout" }, { "$ref": "#/$defs/OutcomeExit" } ], "title": "Outcome" }, "stderr": { "type": "string", "title": "Stderr" }, "stdout": { "type": "string", "title": "Stdout" } }, "additionalProperties": true, "type": "object", "required": [ "outcome", "stderr", "stdout" ], "title": "ResponseFunctionShellCallOutputContentParam", "description": "Captured stdout and stderr for a portion of a shell tool call output." }, "ResponseFunctionShellToolCall": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "$ref": "#/$defs/Action" }, "call_id": { "type": "string", "title": "Call Id" }, "environment": { "anyOf": [ { "$ref": "#/$defs/ResponseLocalEnvironment" }, { "$ref": "#/$defs/ResponseContainerReference" }, { "type": "null" } ], "title": "Environment" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "shell_call", "title": "Type" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "id", "action", "call_id", "status", "type" ], "title": "ResponseFunctionShellToolCall", "description": "A tool call that executes one or more shell commands in a managed environment." }, "ResponseFunctionShellToolCallOutput": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "type": "string", "title": "Call Id" }, "max_output_length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Length" }, "output": { "items": { "$ref": "#/$defs/Output" }, "type": "array", "title": "Output" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "shell_call_output", "title": "Type" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "id", "call_id", "output", "status", "type" ], "title": "ResponseFunctionShellToolCallOutput", "description": "The output of a shell tool call that was emitted." }, "ResponseFunctionToolCall": { "properties": { "arguments": { "type": "string", "title": "Arguments" }, "call_id": { "type": "string", "title": "Call Id" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "function_call", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "async": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Async" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Namespace" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "arguments", "call_id", "name", "type" ], "title": "ResponseFunctionToolCall", "description": "A tool call to run a function.\n\nSee the\n[function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information." }, "ResponseFunctionToolCallOutputItem": { "properties": { "id": { "type": "string", "title": "Id" }, "output": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputText" }, { "$ref": "#/$defs/ResponseInputImage" }, { "$ref": "#/$defs/ResponseInputFile" } ] }, "type": "array" } ], "title": "Output" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "function_call_output", "title": "Type" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "namespace": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Namespace" } }, "additionalProperties": true, "type": "object", "required": [ "id", "output", "status", "type" ], "title": "ResponseFunctionToolCallOutputItem" }, "ResponseFunctionToolCallParam": { "properties": { "async": { "type": "boolean", "title": "Async" }, "arguments": { "type": "string", "title": "Arguments" }, "call_id": { "type": "string", "title": "Call Id" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "function_call", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/CallerDirect" }, { "$ref": "#/$defs/CallerProgram" }, { "type": "null" } ], "title": "Caller" }, "namespace": { "type": "string", "title": "Namespace" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "arguments", "call_id", "name", "type" ], "title": "ResponseFunctionToolCallParam", "description": "A tool call to run a function.\n\nSee the\n[function calling guide](https://developers.openai.com/api/docs/guides/function-calling) for more information." }, "ResponseFunctionWebSearch": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__response_function_web_search__ActionSearch" }, { "$ref": "#/$defs/openai__types__responses__response_function_web_search__ActionOpenPage" }, { "$ref": "#/$defs/ActionFind" } ], "title": "Action" }, "status": { "type": "string", "enum": [ "in_progress", "searching", "completed", "failed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "web_search_call", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "action", "status", "type" ], "title": "ResponseFunctionWebSearch", "description": "The results of a web search tool call.\n\nSee the\n[web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information." }, "ResponseFunctionWebSearchParam": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__response_function_web_search_param__ActionSearch" }, { "$ref": "#/$defs/openai__types__responses__response_function_web_search_param__ActionOpenPage" }, { "$ref": "#/$defs/ActionFind" } ], "title": "Action" }, "status": { "type": "string", "enum": [ "in_progress", "searching", "completed", "incomplete", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "web_search_call", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "action", "status", "type" ], "title": "ResponseFunctionWebSearchParam", "description": "The results of a web search tool call.\n\nSee the\n[web search guide](https://developers.openai.com/api/docs/guides/tools-web-search) for more information." }, "ResponseInputFile": { "properties": { "type": { "type": "string", "const": "input_file", "title": "Type" }, "detail": { "anyOf": [ { "type": "string", "enum": [ "auto", "low", "high" ] }, { "type": "null" } ], "title": "Detail" }, "file_data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Data" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Url" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/$defs/PromptCacheBreakpoint" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseInputFile", "description": "A file input to the model." }, "ResponseInputFileContentParam": { "properties": { "type": { "type": "string", "const": "input_file", "title": "Type" }, "detail": { "type": "string", "enum": [ "auto", "low", "high" ], "title": "Detail" }, "file_data": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Data" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "file_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Url" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/$defs/PromptCacheBreakpoint" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseInputFileContentParam", "description": "A file input to the model." }, "ResponseInputFileParam": { "properties": { "type": { "type": "string", "const": "input_file", "title": "Type" }, "detail": { "type": "string", "enum": [ "auto", "low", "high" ], "title": "Detail" }, "file_data": { "type": "string", "title": "File Data" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "file_url": { "type": "string", "title": "File Url" }, "filename": { "type": "string", "title": "Filename" }, "prompt_cache_breakpoint": { "$ref": "#/$defs/PromptCacheBreakpoint" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseInputFileParam", "description": "A file input to the model." }, "ResponseInputImage": { "properties": { "detail": { "type": "string", "enum": [ "low", "high", "auto", "original" ], "title": "Detail" }, "type": { "type": "string", "const": "input_image", "title": "Type" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/$defs/PromptCacheBreakpoint" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "detail", "type" ], "title": "ResponseInputImage", "description": "An image input to the model.\n\nLearn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)." }, "ResponseInputImageContentParam": { "properties": { "type": { "type": "string", "const": "input_image", "title": "Type" }, "detail": { "anyOf": [ { "type": "string", "enum": [ "low", "high", "auto", "original" ] }, { "type": "null" } ], "title": "Detail" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/$defs/PromptCacheBreakpoint" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseInputImageContentParam", "description": "An image input to the model.\n\nLearn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)" }, "ResponseInputImageParam": { "properties": { "detail": { "type": "string", "enum": [ "low", "high", "auto", "original" ], "title": "Detail" }, "type": { "type": "string", "const": "input_image", "title": "Type" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "prompt_cache_breakpoint": { "$ref": "#/$defs/PromptCacheBreakpoint" } }, "additionalProperties": true, "type": "object", "required": [ "detail", "type" ], "title": "ResponseInputImageParam", "description": "An image input to the model.\n\nLearn about [image inputs](https://developers.openai.com/api/docs/guides/images-vision)." }, "ResponseInputText": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "input_text", "title": "Type" }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/$defs/PromptCacheBreakpoint" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "ResponseInputText", "description": "A text input to the model." }, "ResponseInputTextContentParam": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "input_text", "title": "Type" }, "prompt_cache_breakpoint": { "anyOf": [ { "$ref": "#/$defs/PromptCacheBreakpoint" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "ResponseInputTextContentParam", "description": "A text input to the model." }, "ResponseInputTextParam": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "input_text", "title": "Type" }, "prompt_cache_breakpoint": { "$ref": "#/$defs/PromptCacheBreakpoint" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "ResponseInputTextParam", "description": "A text input to the model." }, "ResponseLocalEnvironment": { "properties": { "type": { "type": "string", "const": "local", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseLocalEnvironment", "description": "Represents the use of a local environment to perform shell actions." }, "ResponseOutputMessage": { "properties": { "id": { "type": "string", "title": "Id" }, "content": { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseOutputText" }, { "$ref": "#/$defs/ResponseOutputRefusal" } ] }, "type": "array", "title": "Content" }, "role": { "type": "string", "const": "assistant", "title": "Role" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "message", "title": "Type" }, "phase": { "anyOf": [ { "type": "string", "enum": [ "commentary", "final_answer" ] }, { "type": "null" } ], "title": "Phase" } }, "additionalProperties": true, "type": "object", "required": [ "id", "content", "role", "status", "type" ], "title": "ResponseOutputMessage", "description": "An output message from the model." }, "ResponseOutputMessageParam": { "properties": { "id": { "type": "string", "title": "Id" }, "content": { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseOutputTextParam" }, { "$ref": "#/$defs/ResponseOutputRefusalParam" } ] }, "type": "array", "title": "Content" }, "role": { "type": "string", "const": "assistant", "title": "Role" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "message", "title": "Type" }, "phase": { "anyOf": [ { "type": "string", "enum": [ "commentary", "final_answer" ] }, { "type": "null" } ], "title": "Phase" } }, "additionalProperties": true, "type": "object", "required": [ "id", "content", "role", "status", "type" ], "title": "ResponseOutputMessageParam", "description": "An output message from the model." }, "ResponseOutputRefusal": { "properties": { "refusal": { "type": "string", "title": "Refusal" }, "type": { "type": "string", "const": "refusal", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "refusal", "type" ], "title": "ResponseOutputRefusal", "description": "A refusal from the model." }, "ResponseOutputRefusalParam": { "properties": { "refusal": { "type": "string", "title": "Refusal" }, "type": { "type": "string", "const": "refusal", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "refusal", "type" ], "title": "ResponseOutputRefusalParam", "description": "A refusal from the model." }, "ResponseOutputText": { "properties": { "annotations": { "items": { "anyOf": [ { "$ref": "#/$defs/AnnotationFileCitation" }, { "$ref": "#/$defs/AnnotationURLCitation" }, { "$ref": "#/$defs/AnnotationContainerFileCitation" }, { "$ref": "#/$defs/AnnotationFilePath" } ] }, "type": "array", "title": "Annotations" }, "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "output_text", "title": "Type" }, "logprobs": { "anyOf": [ { "items": { "$ref": "#/$defs/Logprob" }, "type": "array" }, { "type": "null" } ], "title": "Logprobs" } }, "additionalProperties": true, "type": "object", "required": [ "annotations", "text", "type" ], "title": "ResponseOutputText", "description": "A text output from the model." }, "ResponseOutputTextParam": { "properties": { "annotations": { "items": { "anyOf": [ { "$ref": "#/$defs/AnnotationFileCitation" }, { "$ref": "#/$defs/AnnotationURLCitation" }, { "$ref": "#/$defs/AnnotationContainerFileCitation" }, { "$ref": "#/$defs/AnnotationFilePath" } ] }, "type": "array", "title": "Annotations" }, "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "output_text", "title": "Type" }, "logprobs": { "items": { "$ref": "#/$defs/Logprob" }, "type": "array", "title": "Logprobs" } }, "additionalProperties": true, "type": "object", "required": [ "annotations", "text", "type" ], "title": "ResponseOutputTextParam", "description": "A text output from the model." }, "ResponsePrompt": { "properties": { "id": { "type": "string", "title": "Id" }, "variables": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/ResponseInputText" }, { "$ref": "#/$defs/ResponseInputImage" }, { "$ref": "#/$defs/ResponseInputFile" } ] }, "type": "object" }, { "type": "null" } ], "title": "Variables" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "ResponsePrompt", "description": "Reference to a prompt template and its variables.\n[Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code)." }, "ResponseReasoningItem": { "properties": { "id": { "type": "string", "title": "Id" }, "summary": { "items": { "$ref": "#/$defs/Summary" }, "type": "array", "title": "Summary" }, "type": { "type": "string", "const": "reasoning", "title": "Type" }, "content": { "anyOf": [ { "items": { "$ref": "#/$defs/openai__types__responses__response_reasoning_item__Content" }, "type": "array" }, { "type": "null" } ], "title": "Content" }, "encrypted_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Encrypted Content" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "id", "summary", "type" ], "title": "ResponseReasoningItem", "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](https://developers.openai.com/api/docs/guides/conversation-state)." }, "ResponseReasoningItemParam": { "properties": { "id": { "type": "string", "title": "Id" }, "summary": { "items": { "$ref": "#/$defs/Summary" }, "type": "array", "title": "Summary" }, "type": { "type": "string", "const": "reasoning", "title": "Type" }, "content": { "items": { "$ref": "#/$defs/openai__types__responses__response_reasoning_item_param__Content" }, "type": "array", "title": "Content" }, "encrypted_content": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Encrypted Content" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "id", "summary", "type" ], "title": "ResponseReasoningItemParam", "description": "A description of the chain of thought used by a reasoning model while generating\na response. Be sure to include these items in your `input` to the Responses API\nfor subsequent turns of a conversation if you are manually\n[managing context](https://developers.openai.com/api/docs/guides/conversation-state)." }, "ResponseTextConfig": { "properties": { "format": { "anyOf": [ { "$ref": "#/$defs/ResponseFormatText" }, { "$ref": "#/$defs/ResponseFormatTextJSONSchemaConfig" }, { "$ref": "#/$defs/ResponseFormatJSONObject" }, { "type": "null" } ], "title": "Format" }, "verbosity": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high" ] }, { "type": "null" } ], "title": "Verbosity" } }, "additionalProperties": true, "type": "object", "title": "ResponseTextConfig", "description": "Configuration options for a text response from the model.\n\nCan be plain\ntext or structured JSON data. Learn more:\n- [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)\n- [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)" }, "ResponseToolSearchCall": { "properties": { "id": { "type": "string", "title": "Id" }, "arguments": { "title": "Arguments" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call Id" }, "execution": { "type": "string", "enum": [ "server", "client" ], "title": "Execution" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "tool_search_call", "title": "Type" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "id", "arguments", "execution", "status", "type" ], "title": "ResponseToolSearchCall" }, "ResponseToolSearchOutputItem": { "properties": { "id": { "type": "string", "title": "Id" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call Id" }, "execution": { "type": "string", "enum": [ "server", "client" ], "title": "Execution" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/FunctionTool" }, { "$ref": "#/$defs/FileSearchTool" }, { "$ref": "#/$defs/ComputerTool" }, { "$ref": "#/$defs/ComputerUsePreviewTool" }, { "$ref": "#/$defs/WebSearchTool" }, { "$ref": "#/$defs/openai__types__responses__tool__Mcp" }, { "$ref": "#/$defs/openai__types__responses__tool__CodeInterpreter" }, { "$ref": "#/$defs/ProgrammaticToolCalling" }, { "$ref": "#/$defs/openai__types__responses__tool__ImageGeneration" }, { "$ref": "#/$defs/LocalShell" }, { "$ref": "#/$defs/FunctionShellTool" }, { "$ref": "#/$defs/CustomTool" }, { "$ref": "#/$defs/NamespaceTool" }, { "$ref": "#/$defs/ToolSearchTool" }, { "$ref": "#/$defs/WebSearchPreviewTool" }, { "$ref": "#/$defs/ApplyPatchTool" } ] }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "tool_search_output", "title": "Type" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" } }, "additionalProperties": true, "type": "object", "required": [ "id", "execution", "status", "tools", "type" ], "title": "ResponseToolSearchOutputItem" }, "ResponseToolSearchOutputItemParamParam": { "properties": { "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/FunctionToolParam" }, { "$ref": "#/$defs/FileSearchToolParam" }, { "$ref": "#/$defs/ComputerToolParam" }, { "$ref": "#/$defs/ComputerUsePreviewToolParam" }, { "$ref": "#/$defs/WebSearchToolParam" }, { "$ref": "#/$defs/ToolMcp" }, { "$ref": "#/$defs/ToolCodeInterpreter" }, { "$ref": "#/$defs/ToolProgrammaticToolCalling" }, { "$ref": "#/$defs/ToolImageGeneration" }, { "$ref": "#/$defs/ToolLocalShell" }, { "$ref": "#/$defs/FunctionShellToolParam" }, { "$ref": "#/$defs/CustomToolParam" }, { "$ref": "#/$defs/ToolSearchOutputNamespaceToolParam" }, { "$ref": "#/$defs/ToolSearchToolParam" }, { "$ref": "#/$defs/WebSearchPreviewToolParam" }, { "$ref": "#/$defs/ApplyPatchToolParam" } ] }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "tool_search_output", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call Id" }, "execution": { "type": "string", "enum": [ "server", "client" ], "title": "Execution" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "tools", "type" ], "title": "ResponseToolSearchOutputItemParamParam" }, "Role": { "type": "string", "enum": [ "user", "assistant", "system", "developer", "tool" ], "title": "Role", "description": "The role of a message author (mirrors ``chat::Role``)." }, "Screenshot": { "properties": { "type": { "type": "string", "const": "screenshot", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "Screenshot", "description": "A screenshot action." }, "ShellCall": { "properties": { "action": { "$ref": "#/$defs/ShellCallAction" }, "call_id": { "type": "string", "title": "Call Id" }, "type": { "type": "string", "const": "shell_call", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/ShellCallCallerDirect" }, { "$ref": "#/$defs/ShellCallCallerProgram" }, { "type": "null" } ], "title": "Caller" }, "environment": { "anyOf": [ { "$ref": "#/$defs/LocalEnvironmentParam" }, { "$ref": "#/$defs/ContainerReferenceParam" }, { "type": "null" } ], "title": "Environment" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "action", "call_id", "type" ], "title": "ShellCall", "description": "A tool representing a request to execute one or more shell commands." }, "ShellCallAction": { "properties": { "commands": { "items": { "type": "string" }, "type": "array", "title": "Commands" }, "max_output_length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Length" }, "timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Timeout Ms" } }, "additionalProperties": true, "type": "object", "required": [ "commands" ], "title": "ShellCallAction", "description": "The shell commands and limits that describe how to run the tool call." }, "ShellCallCallerDirect": { "properties": { "type": { "type": "string", "const": "direct", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ShellCallCallerDirect" }, "ShellCallCallerProgram": { "properties": { "caller_id": { "type": "string", "title": "Caller Id" }, "type": { "type": "string", "const": "program", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "caller_id", "type" ], "title": "ShellCallCallerProgram" }, "ShellCallOutput": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "output": { "items": { "$ref": "#/$defs/ResponseFunctionShellCallOutputContentParam" }, "type": "array", "title": "Output" }, "type": { "type": "string", "const": "shell_call_output", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "caller": { "anyOf": [ { "$ref": "#/$defs/ShellCallOutputCallerDirect" }, { "$ref": "#/$defs/ShellCallOutputCallerProgram" }, { "type": "null" } ], "title": "Caller" }, "max_output_length": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Output Length" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type" ], "title": "ShellCallOutput", "description": "The streamed output items emitted by a shell tool call." }, "ShellCallOutputCallerDirect": { "properties": { "type": { "type": "string", "const": "direct", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ShellCallOutputCallerDirect" }, "ShellCallOutputCallerProgram": { "properties": { "caller_id": { "type": "string", "title": "Caller Id" }, "type": { "type": "string", "const": "program", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "caller_id", "type" ], "title": "ShellCallOutputCallerProgram" }, "SkillReference": { "properties": { "skill_id": { "type": "string", "title": "Skill Id" }, "type": { "type": "string", "const": "skill_reference", "title": "Type" }, "version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Version" } }, "additionalProperties": true, "type": "object", "required": [ "skill_id", "type" ], "title": "SkillReference" }, "SkillReferenceParam": { "properties": { "skill_id": { "type": "string", "title": "Skill Id" }, "type": { "type": "string", "const": "skill_reference", "title": "Type" }, "version": { "type": "string", "title": "Version" } }, "additionalProperties": true, "type": "object", "required": [ "skill_id", "type" ], "title": "SkillReferenceParam" }, "StructuredOutputsParams": { "properties": { "json": { "anyOf": [ { "type": "string" }, { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Json" }, "regex": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Regex" }, "choice": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Choice" }, "grammar": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Grammar" }, "json_object": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Json Object" }, "disable_any_whitespace": { "type": "boolean", "title": "Disable Any Whitespace", "default": false }, "disable_additional_properties": { "type": "boolean", "title": "Disable Additional Properties", "default": false }, "whitespace_pattern": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Whitespace Pattern" }, "structural_tag": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Structural Tag" }, "_backend": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Backend" }, "_backend_was_auto": { "type": "boolean", "title": "Backend Was Auto", "default": false } }, "type": "object", "title": "StructuredOutputsParams" }, "Summary": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "summary_text", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "Summary", "description": "A summary text from the model." }, "Text": { "properties": { "type": { "type": "string", "const": "text", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "Text", "description": "Unconstrained free-form text." }, "ToolChoiceAllowed": { "properties": { "mode": { "type": "string", "enum": [ "auto", "required" ], "title": "Mode" }, "tools": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "allowed_tools", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "mode", "tools", "type" ], "title": "ToolChoiceAllowed", "description": "Constrains the tools available to the model to a pre-defined set." }, "ToolChoiceApplyPatch": { "properties": { "type": { "type": "string", "const": "apply_patch", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolChoiceApplyPatch", "description": "Forces the model to call the apply_patch tool when executing a tool call." }, "ToolChoiceCustom": { "properties": { "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "custom", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "ToolChoiceCustom", "description": "Use this option to force the model to call a specific custom tool." }, "ToolChoiceFunction": { "properties": { "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "function", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "ToolChoiceFunction", "description": "Use this option to force the model to call a specific function." }, "ToolChoiceMcp": { "properties": { "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp", "title": "Type" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "additionalProperties": true, "type": "object", "required": [ "server_label", "type" ], "title": "ToolChoiceMcp", "description": "Use this option to force the model to call a specific tool on a remote MCP server." }, "ToolChoiceShell": { "properties": { "type": { "type": "string", "const": "shell", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolChoiceShell", "description": "Forces the model to call the shell tool when a tool call is required." }, "ToolChoiceSpecificProgrammaticToolCallingParam": { "properties": { "type": { "type": "string", "const": "programmatic_tool_calling", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolChoiceSpecificProgrammaticToolCallingParam" }, "ToolChoiceTypes": { "properties": { "type": { "type": "string", "enum": [ "file_search", "web_search_preview", "computer", "computer_use_preview", "computer_use", "web_search_preview_2025_03_11", "image_generation", "code_interpreter" ], "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolChoiceTypes", "description": "Indicates that the model should use a built-in tool to generate a response.\n[Learn more about built-in tools](https://developers.openai.com/api/docs/guides/tools)." }, "ToolCodeInterpreter": { "properties": { "container": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/ToolCodeInterpreterContainerCodeInterpreterToolAuto" } ], "title": "Container" }, "type": { "type": "string", "const": "code_interpreter", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" } }, "additionalProperties": true, "type": "object", "required": [ "container", "type" ], "title": "ToolCodeInterpreter", "description": "A tool that runs Python code to help generate a response to a prompt." }, "ToolCodeInterpreterContainerCodeInterpreterToolAuto": { "properties": { "type": { "type": "string", "const": "auto", "title": "Type" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids" }, "memory_limit": { "anyOf": [ { "type": "string", "enum": [ "1g", "4g", "16g", "64g" ] }, { "type": "null" } ], "title": "Memory Limit" }, "network_policy": { "anyOf": [ { "$ref": "#/$defs/ContainerNetworkPolicyDisabledParam" }, { "$ref": "#/$defs/ContainerNetworkPolicyAllowlistParam" } ], "title": "Network Policy" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolCodeInterpreterContainerCodeInterpreterToolAuto", "description": "Configuration for a code interpreter container.\n\nOptionally specify the IDs of the files to run the code on." }, "ToolImageGeneration": { "properties": { "type": { "type": "string", "const": "image_generation", "title": "Type" }, "action": { "type": "string", "enum": [ "generate", "edit", "auto" ], "title": "Action" }, "background": { "type": "string", "enum": [ "transparent", "opaque", "auto" ], "title": "Background" }, "input_fidelity": { "anyOf": [ { "type": "string", "enum": [ "high", "low" ] }, { "type": "null" } ], "title": "Input Fidelity" }, "input_image_mask": { "$ref": "#/$defs/ToolImageGenerationInputImageMask" }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-image-1", "gpt-image-1-mini", "gpt-image-2", "gpt-image-2-2026-04-21", "gpt-image-2.5-sunburst", "gpt-image-2.5-sunburst-2026-09-08", "gpt-image-2.5-flare", "gpt-image-2.5-flare-2026-09-08", "gpt-image-1.5", "chatgpt-image-latest" ] } ], "title": "Model" }, "moderation": { "type": "string", "enum": [ "auto", "low" ], "title": "Moderation" }, "output_compression": { "type": "integer", "title": "Output Compression" }, "output_format": { "type": "string", "enum": [ "png", "webp", "jpeg" ], "title": "Output Format" }, "partial_images": { "type": "integer", "title": "Partial Images" }, "quality": { "type": "string", "enum": [ "low", "medium", "high", "xhigh", "max", "auto" ], "title": "Quality" }, "size": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "1024x1024", "1024x1536", "1536x1024", "auto" ] } ], "title": "Size" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolImageGeneration", "description": "A tool that generates images using the GPT image models." }, "ToolImageGenerationInputImageMask": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "image_url": { "type": "string", "title": "Image Url" } }, "additionalProperties": true, "type": "object", "title": "ToolImageGenerationInputImageMask", "description": "Optional mask for inpainting.\n\nContains `image_url`\n(string, optional) and `file_id` (string, optional)." }, "ToolLocalShell": { "properties": { "type": { "type": "string", "const": "local_shell", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolLocalShell", "description": "A tool that allows the model to execute shell commands in a local environment." }, "ToolMcp": { "properties": { "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "$ref": "#/$defs/ToolMcpAllowedToolsMcpToolFilter" }, { "type": "null" } ], "title": "Allowed Tools" }, "authorization": { "type": "string", "title": "Authorization" }, "connector_id": { "type": "string", "enum": [ "connector_dropbox", "connector_gmail", "connector_googlecalendar", "connector_googledrive", "connector_microsoftteams", "connector_outlookcalendar", "connector_outlookemail", "connector_sharepoint" ], "title": "Connector Id" }, "defer_loading": { "type": "boolean", "title": "Defer Loading" }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Headers" }, "require_approval": { "anyOf": [ { "$ref": "#/$defs/ToolMcpRequireApprovalMcpToolApprovalFilter" }, { "type": "string", "enum": [ "always", "never" ] }, { "type": "null" } ], "title": "Require Approval" }, "server_description": { "type": "string", "title": "Server Description" }, "server_url": { "type": "string", "title": "Server Url" }, "tunnel_id": { "type": "string", "title": "Tunnel Id" } }, "additionalProperties": true, "type": "object", "required": [ "server_label", "type" ], "title": "ToolMcp", "description": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp)." }, "ToolMcpAllowedToolsMcpToolFilter": { "properties": { "read_only": { "type": "boolean", "title": "Read Only" }, "tool_names": { "items": { "type": "string" }, "type": "array", "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "ToolMcpAllowedToolsMcpToolFilter", "description": "A filter object to specify which tools are allowed." }, "ToolMcpRequireApprovalMcpToolApprovalFilter": { "properties": { "always": { "$ref": "#/$defs/ToolMcpRequireApprovalMcpToolApprovalFilterAlways" }, "never": { "$ref": "#/$defs/ToolMcpRequireApprovalMcpToolApprovalFilterNever" } }, "additionalProperties": true, "type": "object", "title": "ToolMcpRequireApprovalMcpToolApprovalFilter", "description": "Specify which of the MCP server's tools require approval.\n\nCan be\n`always`, `never`, or a filter object associated with tools\nthat require approval." }, "ToolMcpRequireApprovalMcpToolApprovalFilterAlways": { "properties": { "read_only": { "type": "boolean", "title": "Read Only" }, "tool_names": { "items": { "type": "string" }, "type": "array", "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "ToolMcpRequireApprovalMcpToolApprovalFilterAlways", "description": "A filter object to specify which tools are allowed." }, "ToolMcpRequireApprovalMcpToolApprovalFilterNever": { "properties": { "read_only": { "type": "boolean", "title": "Read Only" }, "tool_names": { "items": { "type": "string" }, "type": "array", "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "ToolMcpRequireApprovalMcpToolApprovalFilterNever", "description": "A filter object to specify which tools are allowed." }, "ToolProgrammaticToolCalling": { "properties": { "type": { "type": "string", "const": "programmatic_tool_calling", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolProgrammaticToolCalling" }, "ToolSearchCall": { "properties": { "arguments": { "title": "Arguments" }, "type": { "type": "string", "const": "tool_search_call", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "call_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Call Id" }, "execution": { "type": "string", "enum": [ "server", "client" ], "title": "Execution" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "arguments", "type" ], "title": "ToolSearchCall" }, "ToolSearchOutputNamespaceToolParam": { "properties": { "description": { "type": "string", "title": "Description" }, "name": { "type": "string", "title": "Name" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__tool_search_output_namespace_tool_param__ToolFunction" }, { "$ref": "#/$defs/CustomToolParam" } ] }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "namespace", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "tools", "type" ], "title": "ToolSearchOutputNamespaceToolParam", "description": "Groups function/custom tools under a shared namespace." }, "ToolSearchTool": { "properties": { "type": { "type": "string", "const": "tool_search", "title": "Type" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "execution": { "anyOf": [ { "type": "string", "enum": [ "server", "client" ] }, { "type": "null" } ], "title": "Execution" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "title": "Parameters" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolSearchTool", "description": "Hosted or BYOT tool search configuration for deferred tools." }, "ToolSearchToolParam": { "properties": { "type": { "type": "string", "const": "tool_search", "title": "Type" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "execution": { "type": "string", "enum": [ "server", "client" ], "title": "Execution" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "title": "Parameters" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ToolSearchToolParam", "description": "Hosted or BYOT tool search configuration for deferred tools." }, "Type": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "type", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "Type", "description": "An action to type in text." }, "Wait": { "properties": { "type": { "type": "string", "const": "wait", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "Wait", "description": "A wait action." }, "WebSearchPreviewTool": { "properties": { "type": { "type": "string", "enum": [ "web_search_preview", "web_search_preview_2025_03_11" ], "title": "Type" }, "search_content_types": { "anyOf": [ { "items": { "type": "string", "enum": [ "text", "image" ] }, "type": "array" }, { "type": "null" } ], "title": "Search Content Types" }, "search_context_size": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high" ] }, { "type": "null" } ], "title": "Search Context Size" }, "user_location": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__web_search_preview_tool__UserLocation" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "WebSearchPreviewTool", "description": "This tool searches the web for relevant results to use in a response.\n\nLearn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search)." }, "WebSearchPreviewToolParam": { "properties": { "type": { "type": "string", "enum": [ "web_search_preview", "web_search_preview_2025_03_11" ], "title": "Type" }, "search_content_types": { "items": { "type": "string", "enum": [ "text", "image" ] }, "type": "array", "title": "Search Content Types" }, "search_context_size": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Search Context Size" }, "user_location": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__web_search_preview_tool_param__UserLocation" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "WebSearchPreviewToolParam", "description": "This tool searches the web for relevant results to use in a response.\n\nLearn more about the [web search tool](https://developers.openai.com/api/docs/guides/tools-web-search)." }, "WebSearchTool": { "properties": { "type": { "type": "string", "enum": [ "web_search", "web_search_2025_08_26" ], "title": "Type" }, "external_web_access": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "External Web Access" }, "filters": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__web_search_tool__Filters" }, { "type": "null" } ] }, "search_context_size": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high" ] }, { "type": "null" } ], "title": "Search Context Size" }, "user_location": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__web_search_tool__UserLocation" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "WebSearchTool", "description": "Search the Internet for sources related to the prompt.\n\nLearn more about the\n[web search tool](https://developers.openai.com/api/docs/guides/tools-web-search)." }, "WebSearchToolParam": { "properties": { "type": { "type": "string", "enum": [ "web_search", "web_search_2025_08_26" ], "title": "Type" }, "external_web_access": { "type": "boolean", "title": "External Web Access" }, "filters": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__web_search_tool_param__Filters" }, { "type": "null" } ] }, "search_context_size": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "Search Context Size" }, "user_location": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__web_search_tool_param__UserLocation" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "WebSearchToolParam", "description": "Search the Internet for sources related to the prompt.\n\nLearn more about the\n[web search tool](https://developers.openai.com/api/docs/guides/tools-web-search)." }, "openai__types__responses__computer_action__Click": { "properties": { "button": { "type": "string", "enum": [ "left", "right", "wheel", "back", "forward" ], "title": "Button" }, "type": { "type": "string", "const": "click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "button", "type", "x", "y" ], "title": "Click", "description": "A click action." }, "openai__types__responses__computer_action__DoubleClick": { "properties": { "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" }, "type": { "type": "string", "const": "double_click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" } }, "additionalProperties": true, "type": "object", "required": [ "type", "x", "y" ], "title": "DoubleClick", "description": "A double click action." }, "openai__types__responses__computer_action__Drag": { "properties": { "path": { "items": { "$ref": "#/$defs/DragPath" }, "type": "array", "title": "Path" }, "type": { "type": "string", "const": "drag", "title": "Type" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "path", "type" ], "title": "Drag", "description": "A drag action." }, "openai__types__responses__computer_action__Move": { "properties": { "type": { "type": "string", "const": "move", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "type", "x", "y" ], "title": "Move", "description": "A mouse move action." }, "openai__types__responses__computer_action__Scroll": { "properties": { "scroll_x": { "type": "integer", "title": "Scroll X" }, "scroll_y": { "type": "integer", "title": "Scroll Y" }, "type": { "type": "string", "const": "scroll", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "scroll_x", "scroll_y", "type", "x", "y" ], "title": "Scroll", "description": "A scroll action." }, "openai__types__responses__computer_action_list_param__Click": { "properties": { "button": { "type": "string", "enum": [ "left", "right", "wheel", "back", "forward" ], "title": "Button" }, "type": { "type": "string", "const": "click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "button", "type", "x", "y" ], "title": "Click", "description": "A click action." }, "openai__types__responses__computer_action_list_param__DoubleClick": { "properties": { "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" }, "type": { "type": "string", "const": "double_click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" } }, "additionalProperties": true, "type": "object", "required": [ "keys", "type", "x", "y" ], "title": "DoubleClick", "description": "A double click action." }, "openai__types__responses__computer_action_list_param__Drag": { "properties": { "path": { "items": { "$ref": "#/$defs/DragPath" }, "type": "array", "title": "Path" }, "type": { "type": "string", "const": "drag", "title": "Type" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "path", "type" ], "title": "Drag", "description": "A drag action." }, "openai__types__responses__computer_action_list_param__Move": { "properties": { "type": { "type": "string", "const": "move", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "type", "x", "y" ], "title": "Move", "description": "A mouse move action." }, "openai__types__responses__computer_action_list_param__Scroll": { "properties": { "scroll_x": { "type": "integer", "title": "Scroll X" }, "scroll_y": { "type": "integer", "title": "Scroll Y" }, "type": { "type": "string", "const": "scroll", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "scroll_x", "scroll_y", "type", "x", "y" ], "title": "Scroll", "description": "A scroll action." }, "openai__types__responses__file_search_tool__RankingOptions": { "properties": { "hybrid_search": { "anyOf": [ { "$ref": "#/$defs/RankingOptionsHybridSearch" }, { "type": "null" } ] }, "ranker": { "anyOf": [ { "type": "string", "enum": [ "auto", "default-2024-11-15" ] }, { "type": "null" } ], "title": "Ranker" }, "score_threshold": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score Threshold" } }, "additionalProperties": true, "type": "object", "title": "RankingOptions", "description": "Ranking options for search." }, "openai__types__responses__file_search_tool_param__RankingOptions": { "properties": { "hybrid_search": { "$ref": "#/$defs/RankingOptionsHybridSearch" }, "ranker": { "type": "string", "enum": [ "auto", "default-2024-11-15" ], "title": "Ranker" }, "score_threshold": { "type": "number", "title": "Score Threshold" } }, "additionalProperties": true, "type": "object", "title": "RankingOptions", "description": "Ranking options for search." }, "openai__types__responses__namespace_tool__ToolFunction": { "properties": { "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "function", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "async": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Async" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Defer Loading" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "ToolFunction" }, "openai__types__responses__namespace_tool_param__ToolFunction": { "properties": { "async": { "type": "boolean", "title": "Async" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "function", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "defer_loading": { "type": "boolean", "title": "Defer Loading" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "ToolFunction" }, "openai__types__responses__response_computer_tool_call__ActionClick": { "properties": { "button": { "type": "string", "enum": [ "left", "right", "wheel", "back", "forward" ], "title": "Button" }, "type": { "type": "string", "const": "click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "button", "type", "x", "y" ], "title": "ActionClick", "description": "A click action." }, "openai__types__responses__response_computer_tool_call__ActionDoubleClick": { "properties": { "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" }, "type": { "type": "string", "const": "double_click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" } }, "additionalProperties": true, "type": "object", "required": [ "type", "x", "y" ], "title": "ActionDoubleClick", "description": "A double click action." }, "openai__types__responses__response_computer_tool_call__ActionDrag": { "properties": { "path": { "items": { "$ref": "#/$defs/ActionDragPath" }, "type": "array", "title": "Path" }, "type": { "type": "string", "const": "drag", "title": "Type" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "path", "type" ], "title": "ActionDrag", "description": "A drag action." }, "openai__types__responses__response_computer_tool_call__ActionMove": { "properties": { "type": { "type": "string", "const": "move", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "type", "x", "y" ], "title": "ActionMove", "description": "A mouse move action." }, "openai__types__responses__response_computer_tool_call__ActionScroll": { "properties": { "scroll_x": { "type": "integer", "title": "Scroll X" }, "scroll_y": { "type": "integer", "title": "Scroll Y" }, "type": { "type": "string", "const": "scroll", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "scroll_x", "scroll_y", "type", "x", "y" ], "title": "ActionScroll", "description": "A scroll action." }, "openai__types__responses__response_computer_tool_call__PendingSafetyCheck": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "PendingSafetyCheck", "description": "A pending safety check for the computer call." }, "openai__types__responses__response_computer_tool_call_param__ActionClick": { "properties": { "button": { "type": "string", "enum": [ "left", "right", "wheel", "back", "forward" ], "title": "Button" }, "type": { "type": "string", "const": "click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "button", "type", "x", "y" ], "title": "ActionClick", "description": "A click action." }, "openai__types__responses__response_computer_tool_call_param__ActionDoubleClick": { "properties": { "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" }, "type": { "type": "string", "const": "double_click", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" } }, "additionalProperties": true, "type": "object", "required": [ "keys", "type", "x", "y" ], "title": "ActionDoubleClick", "description": "A double click action." }, "openai__types__responses__response_computer_tool_call_param__ActionDrag": { "properties": { "path": { "items": { "$ref": "#/$defs/ActionDragPath" }, "type": "array", "title": "Path" }, "type": { "type": "string", "const": "drag", "title": "Type" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "path", "type" ], "title": "ActionDrag", "description": "A drag action." }, "openai__types__responses__response_computer_tool_call_param__ActionMove": { "properties": { "type": { "type": "string", "const": "move", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "type", "x", "y" ], "title": "ActionMove", "description": "A mouse move action." }, "openai__types__responses__response_computer_tool_call_param__ActionScroll": { "properties": { "scroll_x": { "type": "integer", "title": "Scroll X" }, "scroll_y": { "type": "integer", "title": "Scroll Y" }, "type": { "type": "string", "const": "scroll", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" }, "keys": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Keys" } }, "additionalProperties": true, "type": "object", "required": [ "scroll_x", "scroll_y", "type", "x", "y" ], "title": "ActionScroll", "description": "A scroll action." }, "openai__types__responses__response_computer_tool_call_param__PendingSafetyCheck": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "PendingSafetyCheck", "description": "A pending safety check for the computer call." }, "openai__types__responses__response_configuration_update_item_param_param__Reasoning": { "properties": { "effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh", "max" ] }, { "type": "null" } ], "title": "Effort" } }, "additionalProperties": true, "type": "object", "title": "Reasoning", "description": "Updates to reasoning configuration. Only effort is supported." }, "openai__types__responses__response_file_search_tool_call__Result": { "properties": { "attributes": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Score" }, "text": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Text" } }, "additionalProperties": true, "type": "object", "title": "Result" }, "openai__types__responses__response_file_search_tool_call_param__Result": { "properties": { "attributes": { "anyOf": [ { "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "object" }, { "type": "null" } ], "title": "Attributes" }, "file_id": { "type": "string", "title": "File Id" }, "filename": { "type": "string", "title": "Filename" }, "score": { "type": "number", "title": "Score" }, "text": { "type": "string", "title": "Text" } }, "additionalProperties": true, "type": "object", "title": "Result" }, "openai__types__responses__response_function_web_search__ActionOpenPage": { "properties": { "type": { "type": "string", "const": "open_page", "title": "Type" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ActionOpenPage", "description": "Action type \"open_page\" - Opens a specific URL from search results." }, "openai__types__responses__response_function_web_search__ActionSearch": { "properties": { "type": { "type": "string", "const": "search", "title": "Type" }, "queries": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Queries" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" }, "sources": { "anyOf": [ { "items": { "$ref": "#/$defs/ActionSearchSource" }, "type": "array" }, { "type": "null" } ], "title": "Sources" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ActionSearch", "description": "Action type \"search\" - Performs a web search query." }, "openai__types__responses__response_function_web_search_param__ActionOpenPage": { "properties": { "type": { "type": "string", "const": "open_page", "title": "Type" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ActionOpenPage", "description": "Action type \"open_page\" - Opens a specific URL from search results." }, "openai__types__responses__response_function_web_search_param__ActionSearch": { "properties": { "type": { "type": "string", "const": "search", "title": "Type" }, "queries": { "items": { "type": "string" }, "type": "array", "title": "Queries" }, "query": { "type": "string", "title": "Query" }, "sources": { "items": { "$ref": "#/$defs/ActionSearchSource" }, "type": "array", "title": "Sources" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ActionSearch", "description": "Action type \"search\" - Performs a web search query." }, "openai__types__responses__response_input_item_param__AdditionalTools": { "properties": { "role": { "type": "string", "const": "developer", "title": "Role" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/FunctionToolParam" }, { "$ref": "#/$defs/FileSearchToolParam" }, { "$ref": "#/$defs/ComputerToolParam" }, { "$ref": "#/$defs/ComputerUsePreviewToolParam" }, { "$ref": "#/$defs/WebSearchToolParam" }, { "$ref": "#/$defs/openai__types__responses__tool_param__Mcp" }, { "$ref": "#/$defs/openai__types__responses__tool_param__CodeInterpreter" }, { "$ref": "#/$defs/ProgrammaticToolCalling" }, { "$ref": "#/$defs/openai__types__responses__tool_param__ImageGeneration" }, { "$ref": "#/$defs/LocalShell" }, { "$ref": "#/$defs/FunctionShellToolParam" }, { "$ref": "#/$defs/CustomToolParam" }, { "$ref": "#/$defs/NamespaceToolParam" }, { "$ref": "#/$defs/ToolSearchToolParam" }, { "$ref": "#/$defs/WebSearchPreviewToolParam" }, { "$ref": "#/$defs/ApplyPatchToolParam" } ] }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "additional_tools", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" } }, "additionalProperties": true, "type": "object", "required": [ "role", "tools", "type" ], "title": "AdditionalTools" }, "openai__types__responses__response_input_item_param__ImageGenerationCall": { "properties": { "id": { "type": "string", "title": "Id" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "generating", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "image_generation_call", "title": "Type" }, "action": { "anyOf": [ { "type": "string", "enum": [ "generate", "edit", "auto" ] }, { "type": "null" } ], "title": "Action" }, "background": { "anyOf": [ { "type": "string", "enum": [ "transparent", "opaque", "auto" ] }, { "type": "null" } ], "title": "Background" }, "error": { "$ref": "#/$defs/openai__types__responses__response_input_item_param__ImageGenerationCallError" }, "output_format": { "anyOf": [ { "type": "string", "enum": [ "png", "webp", "jpeg" ] }, { "type": "null" } ], "title": "Output Format" }, "quality": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "xhigh", "max", "auto" ] }, { "type": "null" } ], "title": "Quality" }, "revised_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revised Prompt" }, "size": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "1024x1024", "1024x1536", "1536x1024" ] }, { "type": "null" } ], "title": "Size" } }, "additionalProperties": true, "type": "object", "required": [ "id", "result", "status", "type" ], "title": "ImageGenerationCall", "description": "An image generation request made by the model." }, "openai__types__responses__response_input_item_param__ImageGenerationCallError": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "type": "string", "title": "Message" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Param" }, "type": { "type": "string", "title": "Type" }, "moderation_details": { "$ref": "#/$defs/ImageGenerationCallErrorModerationDetails" } }, "additionalProperties": true, "type": "object", "required": [ "code", "message", "param", "type" ], "title": "ImageGenerationCallError", "description": "Details of a moderation failure, when available." }, "openai__types__responses__response_input_item_param__LocalShellCall": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "$ref": "#/$defs/openai__types__responses__response_input_item_param__LocalShellCallAction" }, "call_id": { "type": "string", "title": "Call Id" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "local_shell_call", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "action", "call_id", "status", "type" ], "title": "LocalShellCall", "description": "A tool call to run a command on the local shell." }, "openai__types__responses__response_input_item_param__LocalShellCallAction": { "properties": { "command": { "items": { "type": "string" }, "type": "array", "title": "Command" }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env" }, "type": { "type": "string", "const": "exec", "title": "Type" }, "timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Timeout Ms" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "working_directory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Directory" } }, "additionalProperties": true, "type": "object", "required": [ "command", "env", "type" ], "title": "LocalShellCallAction", "description": "Execute a shell command on the server." }, "openai__types__responses__response_input_item_param__LocalShellCallOutput": { "properties": { "id": { "type": "string", "title": "Id" }, "output": { "type": "string", "title": "Output" }, "type": { "type": "string", "const": "local_shell_call_output", "title": "Type" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "id", "output", "type" ], "title": "LocalShellCallOutput", "description": "The output of a local shell tool call." }, "openai__types__responses__response_input_item_param__McpApprovalResponse": { "properties": { "approval_request_id": { "type": "string", "title": "Approval Request Id" }, "approve": { "type": "boolean", "title": "Approve" }, "type": { "type": "string", "const": "mcp_approval_response", "title": "Type" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": true, "type": "object", "required": [ "approval_request_id", "approve", "type" ], "title": "McpApprovalResponse", "description": "A response to an MCP approval request." }, "openai__types__responses__response_input_item_param__McpCall": { "properties": { "id": { "type": "string", "title": "Id" }, "arguments": { "type": "string", "title": "Arguments" }, "name": { "type": "string", "title": "Name" }, "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp_call", "title": "Type" }, "approval_request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approval Request Id" }, "error": { "anyOf": [ { "$ref": "#/$defs/McpProtocolError" }, { "$ref": "#/$defs/McpToolExecutionError" }, { "$ref": "#/$defs/HTTPError" }, { "type": "null" } ], "title": "Error" }, "output": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "calling", "failed" ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "id", "arguments", "name", "server_label", "type" ], "title": "McpCall", "description": "An invocation of a tool on an MCP server." }, "openai__types__responses__response_input_item_param__McpListTools": { "properties": { "id": { "type": "string", "title": "Id" }, "server_label": { "type": "string", "title": "Server Label" }, "tools": { "items": { "$ref": "#/$defs/openai__types__responses__response_input_item_param__McpListToolsTool" }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "mcp_list_tools", "title": "Type" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "additionalProperties": true, "type": "object", "required": [ "id", "server_label", "tools", "type" ], "title": "McpListTools", "description": "A list of tools available on an MCP server." }, "openai__types__responses__response_input_item_param__McpListToolsTool": { "properties": { "input_schema": { "title": "Input Schema" }, "name": { "type": "string", "title": "Name" }, "annotations": { "anyOf": [ {}, { "type": "null" } ], "title": "Annotations" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "additionalProperties": true, "type": "object", "required": [ "input_schema", "name" ], "title": "McpListToolsTool", "description": "A tool available on an MCP server." }, "openai__types__responses__response_input_item_param__Message": { "properties": { "content": { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputTextParam" }, { "$ref": "#/$defs/ResponseInputImageParam" }, { "$ref": "#/$defs/ResponseInputFileParam" } ] }, "type": "array", "title": "Content" }, "role": { "type": "string", "enum": [ "user", "system", "developer" ], "title": "Role" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "message", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "content", "role" ], "title": "Message", "description": "A message input to the model with a role indicating instruction following\nhierarchy. Instructions given with the `developer` or `system` role take\nprecedence over instructions given with the `user` role." }, "openai__types__responses__response_output_item__AdditionalTools": { "properties": { "id": { "type": "string", "title": "Id" }, "role": { "type": "string", "enum": [ "unknown", "user", "assistant", "system", "critic", "discriminator", "developer", "tool" ], "title": "Role" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/FunctionTool" }, { "$ref": "#/$defs/FileSearchTool" }, { "$ref": "#/$defs/ComputerTool" }, { "$ref": "#/$defs/ComputerUsePreviewTool" }, { "$ref": "#/$defs/WebSearchTool" }, { "$ref": "#/$defs/openai__types__responses__tool__Mcp" }, { "$ref": "#/$defs/openai__types__responses__tool__CodeInterpreter" }, { "$ref": "#/$defs/ProgrammaticToolCalling" }, { "$ref": "#/$defs/openai__types__responses__tool__ImageGeneration" }, { "$ref": "#/$defs/LocalShell" }, { "$ref": "#/$defs/FunctionShellTool" }, { "$ref": "#/$defs/CustomTool" }, { "$ref": "#/$defs/NamespaceTool" }, { "$ref": "#/$defs/ToolSearchTool" }, { "$ref": "#/$defs/WebSearchPreviewTool" }, { "$ref": "#/$defs/ApplyPatchTool" } ] }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "additional_tools", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "role", "tools", "type" ], "title": "AdditionalTools" }, "openai__types__responses__response_output_item__ImageGenerationCall": { "properties": { "id": { "type": "string", "title": "Id" }, "result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "generating", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "image_generation_call", "title": "Type" }, "action": { "anyOf": [ { "type": "string", "enum": [ "generate", "edit", "auto" ] }, { "type": "null" } ], "title": "Action" }, "background": { "anyOf": [ { "type": "string", "enum": [ "transparent", "opaque", "auto" ] }, { "type": "null" } ], "title": "Background" }, "error": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__response_output_item__ImageGenerationCallError" }, { "type": "null" } ] }, "output_format": { "anyOf": [ { "type": "string", "enum": [ "png", "webp", "jpeg" ] }, { "type": "null" } ], "title": "Output Format" }, "quality": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "xhigh", "max", "auto" ] }, { "type": "null" } ], "title": "Quality" }, "revised_prompt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revised Prompt" }, "size": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "1024x1024", "1024x1536", "1536x1024" ] }, { "type": "null" } ], "title": "Size" } }, "additionalProperties": true, "type": "object", "required": [ "id", "status", "type" ], "title": "ImageGenerationCall", "description": "An image generation request made by the model." }, "openai__types__responses__response_output_item__ImageGenerationCallError": { "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Code" }, "message": { "type": "string", "title": "Message" }, "param": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Param" }, "type": { "type": "string", "title": "Type" }, "moderation_details": { "anyOf": [ { "$ref": "#/$defs/ImageGenerationCallErrorModerationDetails" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "required": [ "message", "type" ], "title": "ImageGenerationCallError", "description": "Details of a moderation failure, when available." }, "openai__types__responses__response_output_item__LocalShellCall": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "$ref": "#/$defs/openai__types__responses__response_output_item__LocalShellCallAction" }, "call_id": { "type": "string", "title": "Call Id" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "local_shell_call", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "action", "call_id", "status", "type" ], "title": "LocalShellCall", "description": "A tool call to run a command on the local shell." }, "openai__types__responses__response_output_item__LocalShellCallAction": { "properties": { "command": { "items": { "type": "string" }, "type": "array", "title": "Command" }, "env": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Env" }, "type": { "type": "string", "const": "exec", "title": "Type" }, "timeout_ms": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Timeout Ms" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "working_directory": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Working Directory" } }, "additionalProperties": true, "type": "object", "required": [ "command", "env", "type" ], "title": "LocalShellCallAction", "description": "Execute a shell command on the server." }, "openai__types__responses__response_output_item__LocalShellCallOutput": { "properties": { "id": { "type": "string", "title": "Id" }, "output": { "type": "string", "title": "Output" }, "type": { "type": "string", "const": "local_shell_call_output", "title": "Type" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "id", "output", "type" ], "title": "LocalShellCallOutput", "description": "The output of a local shell tool call." }, "openai__types__responses__response_output_item__McpApprovalResponse": { "properties": { "id": { "type": "string", "title": "Id" }, "approval_request_id": { "type": "string", "title": "Approval Request Id" }, "approve": { "type": "boolean", "title": "Approve" }, "type": { "type": "string", "const": "mcp_approval_response", "title": "Type" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reason" } }, "additionalProperties": true, "type": "object", "required": [ "id", "approval_request_id", "approve", "type" ], "title": "McpApprovalResponse", "description": "A response to an MCP approval request." }, "openai__types__responses__response_output_item__McpCall": { "properties": { "id": { "type": "string", "title": "Id" }, "arguments": { "type": "string", "title": "Arguments" }, "name": { "type": "string", "title": "Name" }, "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp_call", "title": "Type" }, "approval_request_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Approval Request Id" }, "error": { "anyOf": [ { "$ref": "#/$defs/McpProtocolError" }, { "$ref": "#/$defs/McpToolExecutionError" }, { "$ref": "#/$defs/HTTPError" }, { "type": "null" } ], "title": "Error" }, "output": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Output" }, "status": { "anyOf": [ { "type": "string", "enum": [ "in_progress", "completed", "incomplete", "calling", "failed" ] }, { "type": "null" } ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "id", "arguments", "name", "server_label", "type" ], "title": "McpCall", "description": "An invocation of a tool on an MCP server." }, "openai__types__responses__response_output_item__McpListTools": { "properties": { "id": { "type": "string", "title": "Id" }, "server_label": { "type": "string", "title": "Server Label" }, "tools": { "items": { "$ref": "#/$defs/openai__types__responses__response_output_item__McpListToolsTool" }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "mcp_list_tools", "title": "Type" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "additionalProperties": true, "type": "object", "required": [ "id", "server_label", "tools", "type" ], "title": "McpListTools", "description": "A list of tools available on an MCP server." }, "openai__types__responses__response_output_item__McpListToolsTool": { "properties": { "input_schema": { "title": "Input Schema" }, "name": { "type": "string", "title": "Name" }, "annotations": { "anyOf": [ {}, { "type": "null" } ], "title": "Annotations" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" } }, "additionalProperties": true, "type": "object", "required": [ "input_schema", "name" ], "title": "McpListToolsTool", "description": "A tool available on an MCP server." }, "openai__types__responses__response_reasoning_item__Content": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "reasoning_text", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "Content", "description": "Reasoning text from the model." }, "openai__types__responses__response_reasoning_item_param__Content": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "reasoning_text", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "Content", "description": "Reasoning text from the model." }, "openai__types__responses__tool__CodeInterpreter": { "properties": { "container": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/openai__types__responses__tool__CodeInterpreterContainerCodeInterpreterToolAuto" } ], "title": "Container" }, "type": { "type": "string", "const": "code_interpreter", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" } }, "additionalProperties": true, "type": "object", "required": [ "container", "type" ], "title": "CodeInterpreter", "description": "A tool that runs Python code to help generate a response to a prompt." }, "openai__types__responses__tool__CodeInterpreterContainerCodeInterpreterToolAuto": { "properties": { "type": { "type": "string", "const": "auto", "title": "Type" }, "file_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "File Ids" }, "memory_limit": { "anyOf": [ { "type": "string", "enum": [ "1g", "4g", "16g", "64g" ] }, { "type": "null" } ], "title": "Memory Limit" }, "network_policy": { "anyOf": [ { "$ref": "#/$defs/ContainerNetworkPolicyDisabled" }, { "$ref": "#/$defs/ContainerNetworkPolicyAllowlist" }, { "type": "null" } ], "title": "Network Policy" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "CodeInterpreterContainerCodeInterpreterToolAuto", "description": "Configuration for a code interpreter container.\n\nOptionally specify the IDs of the files to run the code on." }, "openai__types__responses__tool__ImageGeneration": { "properties": { "type": { "type": "string", "const": "image_generation", "title": "Type" }, "action": { "anyOf": [ { "type": "string", "enum": [ "generate", "edit", "auto" ] }, { "type": "null" } ], "title": "Action" }, "background": { "anyOf": [ { "type": "string", "enum": [ "transparent", "opaque", "auto" ] }, { "type": "null" } ], "title": "Background" }, "input_fidelity": { "anyOf": [ { "type": "string", "enum": [ "high", "low" ] }, { "type": "null" } ], "title": "Input Fidelity" }, "input_image_mask": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__tool__ImageGenerationInputImageMask" }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-image-1", "gpt-image-1-mini", "gpt-image-2", "gpt-image-2-2026-04-21", "gpt-image-2.5-sunburst", "gpt-image-2.5-sunburst-2026-09-08", "gpt-image-2.5-flare", "gpt-image-2.5-flare-2026-09-08", "gpt-image-1.5", "chatgpt-image-latest" ] }, { "type": "null" } ], "title": "Model" }, "moderation": { "anyOf": [ { "type": "string", "enum": [ "auto", "low" ] }, { "type": "null" } ], "title": "Moderation" }, "output_compression": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Output Compression" }, "output_format": { "anyOf": [ { "type": "string", "enum": [ "png", "webp", "jpeg" ] }, { "type": "null" } ], "title": "Output Format" }, "partial_images": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Partial Images" }, "quality": { "anyOf": [ { "type": "string", "enum": [ "low", "medium", "high", "xhigh", "max", "auto" ] }, { "type": "null" } ], "title": "Quality" }, "size": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "1024x1024", "1024x1536", "1536x1024", "auto" ] }, { "type": "null" } ], "title": "Size" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ImageGeneration", "description": "A tool that generates images using the GPT image models." }, "openai__types__responses__tool__ImageGenerationInputImageMask": { "properties": { "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" } }, "additionalProperties": true, "type": "object", "title": "ImageGenerationInputImageMask", "description": "Optional mask for inpainting.\n\nContains `image_url`\n(string, optional) and `file_id` (string, optional)." }, "openai__types__responses__tool__Mcp": { "properties": { "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "$ref": "#/$defs/openai__types__responses__tool__McpAllowedToolsMcpToolFilter" }, { "type": "null" } ], "title": "Allowed Tools" }, "authorization": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" }, "connector_id": { "anyOf": [ { "type": "string", "enum": [ "connector_dropbox", "connector_gmail", "connector_googlecalendar", "connector_googledrive", "connector_microsoftteams", "connector_outlookcalendar", "connector_outlookemail", "connector_sharepoint" ] }, { "type": "null" } ], "title": "Connector Id" }, "defer_loading": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Defer Loading" }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Headers" }, "require_approval": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__tool__McpRequireApprovalMcpToolApprovalFilter" }, { "type": "string", "enum": [ "always", "never" ] }, { "type": "null" } ], "title": "Require Approval" }, "server_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Description" }, "server_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Server Url" }, "tunnel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tunnel Id" } }, "additionalProperties": true, "type": "object", "required": [ "server_label", "type" ], "title": "Mcp", "description": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp)." }, "openai__types__responses__tool__McpAllowedToolsMcpToolFilter": { "properties": { "read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Read Only" }, "tool_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "McpAllowedToolsMcpToolFilter", "description": "A filter object to specify which tools are allowed." }, "openai__types__responses__tool__McpRequireApprovalMcpToolApprovalFilter": { "properties": { "always": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__tool__McpRequireApprovalMcpToolApprovalFilterAlways" }, { "type": "null" } ] }, "never": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__tool__McpRequireApprovalMcpToolApprovalFilterNever" }, { "type": "null" } ] } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilter", "description": "Specify which of the MCP server's tools require approval.\n\nCan be\n`always`, `never`, or a filter object associated with tools\nthat require approval." }, "openai__types__responses__tool__McpRequireApprovalMcpToolApprovalFilterAlways": { "properties": { "read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Read Only" }, "tool_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilterAlways", "description": "A filter object to specify which tools are allowed." }, "openai__types__responses__tool__McpRequireApprovalMcpToolApprovalFilterNever": { "properties": { "read_only": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Read Only" }, "tool_names": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilterNever", "description": "A filter object to specify which tools are allowed." }, "openai__types__responses__tool_param__CodeInterpreter": { "properties": { "container": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/openai__types__responses__tool_param__CodeInterpreterContainerCodeInterpreterToolAuto" } ], "title": "Container" }, "type": { "type": "string", "const": "code_interpreter", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" } }, "additionalProperties": true, "type": "object", "required": [ "container", "type" ], "title": "CodeInterpreter", "description": "A tool that runs Python code to help generate a response to a prompt." }, "openai__types__responses__tool_param__CodeInterpreterContainerCodeInterpreterToolAuto": { "properties": { "type": { "type": "string", "const": "auto", "title": "Type" }, "file_ids": { "items": { "type": "string" }, "type": "array", "title": "File Ids" }, "memory_limit": { "anyOf": [ { "type": "string", "enum": [ "1g", "4g", "16g", "64g" ] }, { "type": "null" } ], "title": "Memory Limit" }, "network_policy": { "anyOf": [ { "$ref": "#/$defs/ContainerNetworkPolicyDisabledParam" }, { "$ref": "#/$defs/ContainerNetworkPolicyAllowlistParam" } ], "title": "Network Policy" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "CodeInterpreterContainerCodeInterpreterToolAuto", "description": "Configuration for a code interpreter container.\n\nOptionally specify the IDs of the files to run the code on." }, "openai__types__responses__tool_param__ImageGeneration": { "properties": { "type": { "type": "string", "const": "image_generation", "title": "Type" }, "action": { "type": "string", "enum": [ "generate", "edit", "auto" ], "title": "Action" }, "background": { "type": "string", "enum": [ "transparent", "opaque", "auto" ], "title": "Background" }, "input_fidelity": { "anyOf": [ { "type": "string", "enum": [ "high", "low" ] }, { "type": "null" } ], "title": "Input Fidelity" }, "input_image_mask": { "$ref": "#/$defs/openai__types__responses__tool_param__ImageGenerationInputImageMask" }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-image-1", "gpt-image-1-mini", "gpt-image-2", "gpt-image-2-2026-04-21", "gpt-image-2.5-sunburst", "gpt-image-2.5-sunburst-2026-09-08", "gpt-image-2.5-flare", "gpt-image-2.5-flare-2026-09-08", "gpt-image-1.5", "chatgpt-image-latest" ] } ], "title": "Model" }, "moderation": { "type": "string", "enum": [ "auto", "low" ], "title": "Moderation" }, "output_compression": { "type": "integer", "title": "Output Compression" }, "output_format": { "type": "string", "enum": [ "png", "webp", "jpeg" ], "title": "Output Format" }, "partial_images": { "type": "integer", "title": "Partial Images" }, "quality": { "type": "string", "enum": [ "low", "medium", "high", "xhigh", "max", "auto" ], "title": "Quality" }, "size": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "1024x1024", "1024x1536", "1536x1024", "auto" ] } ], "title": "Size" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ImageGeneration", "description": "A tool that generates images using the GPT image models." }, "openai__types__responses__tool_param__ImageGenerationInputImageMask": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "image_url": { "type": "string", "title": "Image Url" } }, "additionalProperties": true, "type": "object", "title": "ImageGenerationInputImageMask", "description": "Optional mask for inpainting.\n\nContains `image_url`\n(string, optional) and `file_id` (string, optional)." }, "openai__types__responses__tool_param__Mcp": { "properties": { "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "$ref": "#/$defs/openai__types__responses__tool_param__McpAllowedToolsMcpToolFilter" }, { "type": "null" } ], "title": "Allowed Tools" }, "authorization": { "type": "string", "title": "Authorization" }, "connector_id": { "type": "string", "enum": [ "connector_dropbox", "connector_gmail", "connector_googlecalendar", "connector_googledrive", "connector_microsoftteams", "connector_outlookcalendar", "connector_outlookemail", "connector_sharepoint" ], "title": "Connector Id" }, "defer_loading": { "type": "boolean", "title": "Defer Loading" }, "headers": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Headers" }, "require_approval": { "anyOf": [ { "$ref": "#/$defs/openai__types__responses__tool_param__McpRequireApprovalMcpToolApprovalFilter" }, { "type": "string", "enum": [ "always", "never" ] }, { "type": "null" } ], "title": "Require Approval" }, "server_description": { "type": "string", "title": "Server Description" }, "server_url": { "type": "string", "title": "Server Url" }, "tunnel_id": { "type": "string", "title": "Tunnel Id" } }, "additionalProperties": true, "type": "object", "required": [ "server_label", "type" ], "title": "Mcp", "description": "Give the model access to additional tools via remote Model Context Protocol\n(MCP) servers. [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp)." }, "openai__types__responses__tool_param__McpAllowedToolsMcpToolFilter": { "properties": { "read_only": { "type": "boolean", "title": "Read Only" }, "tool_names": { "items": { "type": "string" }, "type": "array", "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "McpAllowedToolsMcpToolFilter", "description": "A filter object to specify which tools are allowed." }, "openai__types__responses__tool_param__McpRequireApprovalMcpToolApprovalFilter": { "properties": { "always": { "$ref": "#/$defs/openai__types__responses__tool_param__McpRequireApprovalMcpToolApprovalFilterAlways" }, "never": { "$ref": "#/$defs/openai__types__responses__tool_param__McpRequireApprovalMcpToolApprovalFilterNever" } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilter", "description": "Specify which of the MCP server's tools require approval.\n\nCan be\n`always`, `never`, or a filter object associated with tools\nthat require approval." }, "openai__types__responses__tool_param__McpRequireApprovalMcpToolApprovalFilterAlways": { "properties": { "read_only": { "type": "boolean", "title": "Read Only" }, "tool_names": { "items": { "type": "string" }, "type": "array", "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilterAlways", "description": "A filter object to specify which tools are allowed." }, "openai__types__responses__tool_param__McpRequireApprovalMcpToolApprovalFilterNever": { "properties": { "read_only": { "type": "boolean", "title": "Read Only" }, "tool_names": { "items": { "type": "string" }, "type": "array", "title": "Tool Names" } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilterNever", "description": "A filter object to specify which tools are allowed." }, "openai__types__responses__tool_search_output_namespace_tool_param__ToolFunction": { "properties": { "async": { "type": "boolean", "title": "Async" }, "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "function", "title": "Type" }, "allowed_callers": { "anyOf": [ { "items": { "type": "string", "enum": [ "direct", "programmatic" ] }, "type": "array" }, { "type": "null" } ], "title": "Allowed Callers" }, "defer_loading": { "type": "boolean", "title": "Defer Loading" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "output_schema": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Output Schema" }, "parameters": { "anyOf": [ {}, { "type": "null" } ], "title": "Parameters" }, "strict": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Strict" } }, "additionalProperties": true, "type": "object", "required": [ "name", "type" ], "title": "ToolFunction" }, "openai__types__responses__web_search_preview_tool__UserLocation": { "properties": { "type": { "type": "string", "const": "approximate", "title": "Type" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "UserLocation", "description": "The approximate location of the user.\n\nIf omitted or null, defaults to the United States. To avoid this fallback, pass `{\"type\": \"approximate\"}` without location fields. To localize results, provide the relevant location fields." }, "openai__types__responses__web_search_preview_tool_param__UserLocation": { "properties": { "type": { "type": "string", "const": "approximate", "title": "Type" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "UserLocation", "description": "The approximate location of the user.\n\nIf omitted or null, defaults to the United States. To avoid this fallback, pass `{\"type\": \"approximate\"}` without location fields. To localize results, provide the relevant location fields." }, "openai__types__responses__web_search_tool__Filters": { "properties": { "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Domains" } }, "additionalProperties": true, "type": "object", "title": "Filters", "description": "Filters for the search." }, "openai__types__responses__web_search_tool__UserLocation": { "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "type": { "anyOf": [ { "type": "string", "const": "approximate" }, { "type": "null" } ], "title": "Type" } }, "additionalProperties": true, "type": "object", "title": "UserLocation", "description": "The approximate location of the user.\n\nIf omitted or null, defaults to the\nUnited States. To avoid this fallback, pass `{\"type\": \"approximate\"}` without\nlocation fields. To localize results, provide the relevant location fields." }, "openai__types__responses__web_search_tool_param__Filters": { "properties": { "allowed_domains": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Allowed Domains" } }, "additionalProperties": true, "type": "object", "title": "Filters", "description": "Filters for the search." }, "openai__types__responses__web_search_tool_param__UserLocation": { "properties": { "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "City" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "region": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Region" }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Timezone" }, "type": { "type": "string", "const": "approximate", "title": "Type" } }, "additionalProperties": true, "type": "object", "title": "UserLocation", "description": "The approximate location of the user.\n\nIf omitted or null, defaults to the\nUnited States. To avoid this fallback, pass `{\"type\": \"approximate\"}` without\nlocation fields. To localize results, provide the relevant location fields." }, "openai__types__shared__comparison_filter__ComparisonFilter": { "properties": { "key": { "type": "string", "title": "Key" }, "type": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "in", "nin" ], "title": "Type" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "type": "array" } ], "title": "Value" } }, "additionalProperties": true, "type": "object", "required": [ "key", "type", "value" ], "title": "ComparisonFilter", "description": "A filter used to compare a specified attribute key to a given value using a defined comparison operation." }, "openai__types__shared__compound_filter__CompoundFilter": { "properties": { "filters": { "items": { "anyOf": [ { "$ref": "#/$defs/openai__types__shared__comparison_filter__ComparisonFilter" }, {} ] }, "type": "array", "title": "Filters" }, "type": { "type": "string", "enum": [ "and", "or" ], "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "filters", "type" ], "title": "CompoundFilter", "description": "Combine multiple filters using `and` or `or`." }, "openai__types__shared__reasoning__Reasoning": { "properties": { "context": { "anyOf": [ { "type": "string", "enum": [ "auto", "current_turn", "all_turns" ] }, { "type": "null" } ], "title": "Context" }, "effort": { "anyOf": [ { "type": "string", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh", "max" ] }, { "type": "null" } ], "title": "Effort" }, "generate_summary": { "anyOf": [ { "type": "string", "enum": [ "auto", "concise", "detailed" ] }, { "type": "null" } ], "title": "Generate Summary" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "standard", "pro" ] }, { "type": "null" } ], "title": "Mode" }, "summary": { "anyOf": [ { "type": "string", "enum": [ "auto", "concise", "detailed" ] }, { "type": "null" } ], "title": "Summary" } }, "additionalProperties": true, "type": "object", "title": "Reasoning", "description": "Configuration options for\n[reasoning models](https://developers.openai.com/api/docs/guides/reasoning)." }, "openai__types__shared_params__comparison_filter__ComparisonFilter": { "properties": { "key": { "type": "string", "title": "Key" }, "type": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte", "in", "nin" ], "title": "Type" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" }, { "items": { "anyOf": [ { "type": "number" }, { "type": "string" } ] }, "type": "array" } ], "title": "Value" } }, "additionalProperties": true, "type": "object", "required": [ "key", "type", "value" ], "title": "ComparisonFilter", "description": "A filter used to compare a specified attribute key to a given value using a defined comparison operation." }, "openai__types__shared_params__compound_filter__CompoundFilter": { "properties": { "filters": { "items": { "anyOf": [ { "$ref": "#/$defs/openai__types__shared_params__comparison_filter__ComparisonFilter" }, {} ] }, "type": "array", "title": "Filters" }, "type": { "type": "string", "enum": [ "and", "or" ], "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "filters", "type" ], "title": "CompoundFilter", "description": "Combine multiple filters using `and` or `or`." }, "openai_harmony__Content": { "properties": {}, "type": "object", "title": "Content" }, "openai_harmony__Message": { "properties": { "author": { "$ref": "#/$defs/Author" }, "content": { "items": { "$ref": "#/$defs/openai_harmony__Content" }, "type": "array", "title": "Content" }, "channel": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel" }, "recipient": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Recipient" }, "content_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Content Type" } }, "type": "object", "required": [ "author" ], "title": "Message" } } }