{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://artifacts.apis.io/scale-ai/json-schema/scale-ai-response-object-schema.json", "title": "ResponseObject", "x-generated": "2026-10-27", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/scale-ai-sgp-v5-openapi.yml#/components/schemas/ResponseObject", "properties": { "id": { "type": "string", "title": "Id" }, "object": { "type": "string", "const": "response", "title": "Object", "default": "response" }, "created_at": { "type": "number", "title": "Created At" }, "error": { "$ref": "#/$defs/ResponseError" }, "incomplete_details": { "$ref": "#/$defs/IncompleteDetails" }, "instructions": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/EasyInputMessage" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__Message" }, { "$ref": "#/$defs/ResponseOutputMessage" }, { "$ref": "#/$defs/ResponseFileSearchToolCall" }, { "$ref": "#/$defs/ResponseComputerToolCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__ComputerCallOutput" }, { "$ref": "#/$defs/ResponseFunctionWebSearch" }, { "$ref": "#/$defs/ResponseFunctionToolCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__FunctionCallOutput" }, { "$ref": "#/$defs/ResponseReasoningItem" }, { "$ref": "#/$defs/ResponseCompactionItemParam" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__ImageGenerationCall" }, { "$ref": "#/$defs/ResponseCodeInterpreterToolCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__LocalShellCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__LocalShellCallOutput" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__ShellCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__ShellCallOutput" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__ApplyPatchCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__ApplyPatchCallOutput" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__McpListTools" }, { "$ref": "#/$defs/McpApprovalRequest" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__McpApprovalResponse" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__McpCall" }, { "$ref": "#/$defs/ResponseCustomToolCallOutput" }, { "$ref": "#/$defs/ResponseCustomToolCall" }, { "$ref": "#/$defs/openai__types__responses__response_input_item__ItemReference" } ] }, "type": "array" } ], "title": "Instructions" }, "metadata": { "title": "Metadata", "additionalProperties": { "type": "string" }, "type": "object" }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-5.2", "gpt-5.2-2025-12-11", "gpt-5.2-chat-latest", "gpt-5.2-pro", "gpt-5.2-pro-2025-12-11", "gpt-5.1", "gpt-5.1-2025-11-13", "gpt-5.1-codex", "gpt-5.1-mini", "gpt-5.1-chat-latest", "gpt-5", "gpt-5-mini", "gpt-5-nano", "gpt-5-2025-08-07", "gpt-5-mini-2025-08-07", "gpt-5-nano-2025-08-07", "gpt-5-chat-latest", "gpt-4.1", "gpt-4.1-mini", "gpt-4.1-nano", "gpt-4.1-2025-04-14", "gpt-4.1-mini-2025-04-14", "gpt-4.1-nano-2025-04-14", "o4-mini", "o4-mini-2025-04-16", "o3", "o3-2025-04-16", "o3-mini", "o3-mini-2025-01-31", "o1", "o1-2024-12-17", "o1-preview", "o1-preview-2024-09-12", "o1-mini", "o1-mini-2024-09-12", "gpt-4o", "gpt-4o-2024-11-20", "gpt-4o-2024-08-06", "gpt-4o-2024-05-13", "gpt-4o-audio-preview", "gpt-4o-audio-preview-2024-10-01", "gpt-4o-audio-preview-2024-12-17", "gpt-4o-audio-preview-2025-06-03", "gpt-4o-mini-audio-preview", "gpt-4o-mini-audio-preview-2024-12-17", "gpt-4o-search-preview", "gpt-4o-mini-search-preview", "gpt-4o-search-preview-2025-03-11", "gpt-4o-mini-search-preview-2025-03-11", "chatgpt-4o-latest", "codex-mini-latest", "gpt-4o-mini", "gpt-4o-mini-2024-07-18", "gpt-4-turbo", "gpt-4-turbo-2024-04-09", "gpt-4-0125-preview", "gpt-4-turbo-preview", "gpt-4-1106-preview", "gpt-4-vision-preview", "gpt-4", "gpt-4-0314", "gpt-4-0613", "gpt-4-32k", "gpt-4-32k-0314", "gpt-4-32k-0613", "gpt-3.5-turbo", "gpt-3.5-turbo-16k", "gpt-3.5-turbo-0301", "gpt-3.5-turbo-0613", "gpt-3.5-turbo-1106", "gpt-3.5-turbo-0125", "gpt-3.5-turbo-16k-0613" ] }, { "type": "string", "enum": [ "o1-pro", "o1-pro-2025-03-19", "o3-pro", "o3-pro-2025-06-10", "o3-deep-research", "o3-deep-research-2025-06-26", "o4-mini-deep-research", "o4-mini-deep-research-2025-06-26", "computer-use-preview", "computer-use-preview-2025-03-11", "gpt-5-codex", "gpt-5-pro", "gpt-5-pro-2025-10-06", "gpt-5.1-codex-max" ] } ], "title": "Model" }, "output": { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseOutputMessage" }, { "$ref": "#/$defs/ResponseFileSearchToolCall" }, { "$ref": "#/$defs/ResponseFunctionToolCall" }, { "$ref": "#/$defs/ResponseFunctionWebSearch" }, { "$ref": "#/$defs/ResponseComputerToolCall" }, { "$ref": "#/$defs/ResponseReasoningItem" }, { "$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/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/ResponseCustomToolCall" } ] }, "type": "array", "title": "Output" }, "parallel_tool_calls": { "type": "boolean", "title": "Parallel Tool Calls" }, "temperature": { "title": "Temperature", "type": "number" }, "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/ToolChoiceApplyPatch" }, { "$ref": "#/$defs/ToolChoiceShell" } ], "title": "Tool Choice" }, "tools": { "items": { "anyOf": [ { "$ref": "#/$defs/FunctionTool" }, { "$ref": "#/$defs/FileSearchTool" }, { "$ref": "#/$defs/ComputerTool" }, { "$ref": "#/$defs/WebSearchTool" }, { "$ref": "#/$defs/Mcp" }, { "$ref": "#/$defs/CodeInterpreter" }, { "$ref": "#/$defs/ImageGeneration" }, { "$ref": "#/$defs/LocalShell" }, { "$ref": "#/$defs/FunctionShellTool" }, { "$ref": "#/$defs/CustomTool" }, { "$ref": "#/$defs/WebSearchPreviewTool" }, { "$ref": "#/$defs/ApplyPatchTool" } ] }, "type": "array", "title": "Tools" }, "top_p": { "title": "Top P", "type": "number" }, "background": { "title": "Background", "type": "boolean" }, "completed_at": { "title": "Completed At", "type": "number" }, "conversation": { "$ref": "#/$defs/Conversation" }, "max_output_tokens": { "title": "Max Output Tokens", "type": "integer" }, "max_tool_calls": { "title": "Max Tool Calls", "type": "integer" }, "previous_response_id": { "title": "Previous Response Id", "type": "string" }, "prompt": { "$ref": "#/$defs/ResponsePrompt" }, "prompt_cache_key": { "title": "Prompt Cache Key", "type": "string" }, "prompt_cache_retention": { "title": "Prompt Cache Retention", "type": "string", "enum": [ "in-memory", "24h" ] }, "reasoning": { "$ref": "#/$defs/Reasoning" }, "safety_identifier": { "title": "Safety Identifier", "type": "string" }, "service_tier": { "title": "Service Tier", "type": "string", "enum": [ "auto", "default", "flex", "scale", "priority" ] }, "status": { "title": "Status", "type": "string", "enum": [ "completed", "failed", "in_progress", "cancelled", "queued", "incomplete" ] }, "text": { "$ref": "#/$defs/ResponseTextConfig" }, "top_logprobs": { "title": "Top Logprobs", "type": "integer" }, "truncation": { "title": "Truncation", "type": "string", "enum": [ "auto", "disabled" ] }, "usage": { "$ref": "#/$defs/ResponseUsage" }, "user": { "title": "User", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "id", "created_at", "model", "output", "parallel_tool_calls", "tool_choice", "tools" ], "$defs": { "Action": { "properties": { "commands": { "items": { "type": "string" }, "type": "array", "title": "Commands" }, "max_output_length": { "title": "Max Output Length", "type": "integer" }, "timeout_ms": { "title": "Timeout Ms", "type": "integer" } }, "additionalProperties": true, "type": "object", "required": [ "commands" ], "title": "Action", "description": "The shell commands and limits that describe how to run the 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" } }, "additionalProperties": true, "type": "object", "required": [ "button", "type", "x", "y" ], "title": "ActionClick", "description": "A click action." }, "ActionDoubleClick": { "properties": { "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." }, "ActionDrag": { "properties": { "path": { "items": { "$ref": "#/$defs/ActionDragPath" }, "type": "array", "title": "Path" }, "type": { "type": "string", "const": "drag", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "path", "type" ], "title": "ActionDrag", "description": "A drag action." }, "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." }, "ActionMove": { "properties": { "type": { "type": "string", "const": "move", "title": "Type" }, "x": { "type": "integer", "title": "X" }, "y": { "type": "integer", "title": "Y" } }, "additionalProperties": true, "type": "object", "required": [ "type", "x", "y" ], "title": "ActionMove", "description": "A mouse move action." }, "ActionScreenshot": { "properties": { "type": { "type": "string", "const": "screenshot", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ActionScreenshot", "description": "A screenshot action." }, "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" } }, "additionalProperties": true, "type": "object", "required": [ "scroll_x", "scroll_y", "type", "x", "y" ], "title": "ActionScroll", "description": "A scroll 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." }, "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." }, "ApplyPatchTool": { "properties": { "type": { "type": "string", "const": "apply_patch", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ApplyPatchTool", "description": "Allows the assistant to create, delete, or update files using unified diffs." }, "CodeInterpreter": { "properties": { "container": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/CodeInterpreterContainerCodeInterpreterToolAuto" } ], "title": "Container" }, "type": { "type": "string", "const": "code_interpreter", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "container", "type" ], "title": "CodeInterpreter", "description": "A tool that runs Python code to help generate a response to a prompt." }, "CodeInterpreterContainerCodeInterpreterToolAuto": { "properties": { "type": { "type": "string", "const": "auto", "title": "Type" }, "file_ids": { "title": "File Ids", "items": { "type": "string" }, "type": "array" }, "memory_limit": { "title": "Memory Limit", "type": "string", "enum": [ "1g", "4g", "16g", "64g" ] }, "network_policy": { "anyOf": [ { "$ref": "#/$defs/ContainerNetworkPolicyDisabled" }, { "$ref": "#/$defs/ContainerNetworkPolicyAllowlist" } ], "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." }, "ComparisonFilter": { "properties": { "key": { "type": "string", "title": "Key" }, "type": { "type": "string", "enum": [ "eq", "ne", "gt", "gte", "lt", "lte" ], "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." }, "CompoundFilter": { "properties": { "filters": { "items": { "anyOf": [ { "$ref": "#/$defs/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`." }, "ComputerTool": { "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": "ComputerTool", "description": "A tool that controls a virtual computer.\n\nLearn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use)." }, "ContainerAuto": { "properties": { "type": { "type": "string", "const": "container_auto", "title": "Type" }, "file_ids": { "title": "File Ids", "items": { "type": "string" }, "type": "array" }, "memory_limit": { "title": "Memory Limit", "type": "string", "enum": [ "1g", "4g", "16g", "64g" ] }, "network_policy": { "anyOf": [ { "$ref": "#/$defs/ContainerNetworkPolicyDisabled" }, { "$ref": "#/$defs/ContainerNetworkPolicyAllowlist" } ], "title": "Network Policy" }, "skills": { "title": "Skills", "items": { "anyOf": [ { "$ref": "#/$defs/SkillReference" }, { "$ref": "#/$defs/InlineSkill" } ] }, "type": "array" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ContainerAuto" }, "ContainerNetworkPolicyAllowlist": { "properties": { "allowed_domains": { "items": { "type": "string" }, "type": "array", "title": "Allowed Domains" }, "type": { "type": "string", "const": "allowlist", "title": "Type" }, "domain_secrets": { "title": "Domain Secrets", "items": { "$ref": "#/$defs/ContainerNetworkPolicyDomainSecret" }, "type": "array" } }, "additionalProperties": true, "type": "object", "required": [ "allowed_domains", "type" ], "title": "ContainerNetworkPolicyAllowlist" }, "ContainerNetworkPolicyDisabled": { "properties": { "type": { "type": "string", "const": "disabled", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ContainerNetworkPolicyDisabled" }, "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" }, "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" }, "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." }, "Conversation": { "properties": { "id": { "type": "string", "title": "Id" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "Conversation", "description": "The conversation that this response belonged to.\n\nInput items and output items from this response were automatically added to this conversation." }, "CustomTool": { "properties": { "name": { "type": "string", "title": "Name" }, "type": { "type": "string", "const": "custom", "title": "Type" }, "description": { "title": "Description", "type": "string" }, "format": { "anyOf": [ { "$ref": "#/$defs/Text" }, { "$ref": "#/$defs/Grammar" } ], "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://platform.openai.com/docs/guides/function-calling#custom-tools)" }, "EasyInputMessage": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputText" }, { "$ref": "#/$defs/ResponseInputImage" }, { "$ref": "#/$defs/ResponseInputFile" } ] }, "type": "array" } ], "title": "Content" }, "role": { "type": "string", "enum": [ "user", "assistant", "system", "developer" ], "title": "Role" }, "phase": { "title": "Phase", "type": "string", "enum": [ "commentary", "final_answer" ] }, "type": { "title": "Type", "type": "string", "const": "message" } }, "additionalProperties": true, "type": "object", "required": [ "content", "role" ], "title": "EasyInputMessage", "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/ComparisonFilter" }, { "$ref": "#/$defs/CompoundFilter" } ], "title": "Filters" }, "max_num_results": { "title": "Max Num Results", "type": "integer" }, "ranking_options": { "$ref": "#/$defs/RankingOptions" } }, "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://platform.openai.com/docs/guides/tools-file-search)." }, "Filters": { "properties": { "allowed_domains": { "items": { "type": "string" }, "type": "array", "title": "Allowed Domains" } }, "additionalProperties": true, "type": "object", "title": "Filters", "description": "Filters for the search." }, "FunctionShellTool": { "properties": { "type": { "type": "string", "const": "shell", "title": "Type" }, "environment": { "anyOf": [ { "$ref": "#/$defs/ContainerAuto" }, { "$ref": "#/$defs/LocalEnvironment" }, { "$ref": "#/$defs/ContainerReference" } ], "title": "Environment" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "FunctionShellTool", "description": "A tool that allows the model to execute shell commands." }, "FunctionTool": { "properties": { "name": { "type": "string", "title": "Name" }, "parameters": { "title": "Parameters", "additionalProperties": true, "type": "object" }, "strict": { "title": "Strict", "type": "boolean" }, "type": { "type": "string", "const": "function", "title": "Type" }, "description": { "title": "Description", "type": "string" } }, "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://platform.openai.com/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." }, "ImageGeneration": { "properties": { "type": { "type": "string", "const": "image_generation", "title": "Type" }, "action": { "title": "Action", "type": "string", "enum": [ "generate", "edit", "auto" ] }, "background": { "title": "Background", "type": "string", "enum": [ "transparent", "opaque", "auto" ] }, "input_fidelity": { "title": "Input Fidelity", "type": "string", "enum": [ "high", "low" ] }, "input_image_mask": { "$ref": "#/$defs/ImageGenerationInputImageMask" }, "model": { "anyOf": [ { "type": "string" }, { "type": "string", "enum": [ "gpt-image-1", "gpt-image-1-mini", "gpt-image-1.5" ] } ], "title": "Model" }, "moderation": { "title": "Moderation", "type": "string", "enum": [ "auto", "low" ] }, "output_compression": { "title": "Output Compression", "type": "integer" }, "output_format": { "title": "Output Format", "type": "string", "enum": [ "png", "webp", "jpeg" ] }, "partial_images": { "title": "Partial Images", "type": "integer" }, "quality": { "title": "Quality", "type": "string", "enum": [ "low", "medium", "high", "auto" ] }, "size": { "title": "Size", "type": "string", "enum": [ "1024x1024", "1024x1536", "1536x1024", "auto" ] } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ImageGeneration", "description": "A tool that generates images using the GPT image models." }, "ImageGenerationInputImageMask": { "properties": { "file_id": { "type": "string", "title": "File Id" }, "image_url": { "title": "Image Url", "type": "string" } }, "additionalProperties": true, "type": "object", "title": "ImageGenerationInputImageMask", "description": "Optional mask for inpainting.\n\nContains `image_url`\n(string, optional) and `file_id` (string, optional)." }, "IncompleteDetails": { "properties": { "reason": { "title": "Reason", "type": "string", "enum": [ "max_output_tokens", "content_filter" ] } }, "additionalProperties": true, "type": "object", "title": "IncompleteDetails", "description": "Details about why the response is incomplete." }, "InlineSkill": { "properties": { "description": { "title": "Description", "type": "string" }, "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" }, "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" }, "InputTokensDetails": { "properties": { "cached_tokens": { "type": "integer", "title": "Cached Tokens" } }, "additionalProperties": true, "type": "object", "required": [ "cached_tokens" ], "title": "InputTokensDetails", "description": "A detailed breakdown of the input tokens." }, "LocalEnvironment": { "properties": { "type": { "type": "string", "const": "local", "title": "Type" }, "skills": { "title": "Skills", "items": { "$ref": "#/$defs/LocalSkill" }, "type": "array" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "LocalEnvironment" }, "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": { "title": "Description", "type": "string" }, "name": { "type": "string", "title": "Name" }, "path": { "type": "string", "title": "Path" } }, "additionalProperties": true, "type": "object", "required": [ "description", "name", "path" ], "title": "LocalSkill" }, "Mcp": { "properties": { "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp", "title": "Type" }, "allowed_tools": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "$ref": "#/$defs/McpAllowedToolsMcpToolFilter" } ], "title": "Allowed Tools" }, "authorization": { "title": "Authorization", "type": "string" }, "connector_id": { "title": "Connector Id", "type": "string", "enum": [ "connector_dropbox", "connector_gmail", "connector_googlecalendar", "connector_googledrive", "connector_microsoftteams", "connector_outlookcalendar", "connector_outlookemail", "connector_sharepoint" ] }, "headers": { "title": "Headers", "additionalProperties": { "type": "string" }, "type": "object" }, "require_approval": { "anyOf": [ { "$ref": "#/$defs/McpRequireApprovalMcpToolApprovalFilter" }, { "type": "string", "enum": [ "always", "never" ] } ], "title": "Require Approval" }, "server_description": { "title": "Server Description", "type": "string" }, "server_url": { "title": "Server Url", "type": "string" } }, "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://platform.openai.com/docs/guides/tools-remote-mcp)." }, "McpAllowedToolsMcpToolFilter": { "properties": { "read_only": { "title": "Read Only", "type": "boolean" }, "tool_names": { "title": "Tool Names", "items": { "type": "string" }, "type": "array" } }, "additionalProperties": true, "type": "object", "title": "McpAllowedToolsMcpToolFilter", "description": "A filter object to specify which tools are allowed." }, "McpApprovalRequest": { "properties": { "id": { "type": "string", "title": "Id" }, "arguments": { "title": "Arguments", "type": "string" }, "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." }, "McpRequireApprovalMcpToolApprovalFilter": { "properties": { "always": { "$ref": "#/$defs/McpRequireApprovalMcpToolApprovalFilterAlways" }, "never": { "$ref": "#/$defs/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." }, "McpRequireApprovalMcpToolApprovalFilterAlways": { "properties": { "read_only": { "title": "Read Only", "type": "boolean" }, "tool_names": { "title": "Tool Names", "items": { "type": "string" }, "type": "array" } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilterAlways", "description": "A filter object to specify which tools are allowed." }, "McpRequireApprovalMcpToolApprovalFilterNever": { "properties": { "read_only": { "title": "Read Only", "type": "boolean" }, "tool_names": { "title": "Tool Names", "items": { "type": "string" }, "type": "array" } }, "additionalProperties": true, "type": "object", "title": "McpRequireApprovalMcpToolApprovalFilterNever", "description": "A filter object to specify which tools are allowed." }, "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": { "title": "Created By", "type": "string" } }, "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." }, "OutputTokensDetails": { "properties": { "reasoning_tokens": { "title": "Reasoning Tokens", "type": "integer" } }, "additionalProperties": true, "type": "object", "required": [ "reasoning_tokens" ], "title": "OutputTokensDetails", "description": "A detailed breakdown of the output tokens." }, "RankingOptions": { "properties": { "hybrid_search": { "$ref": "#/$defs/RankingOptionsHybridSearch" }, "ranker": { "title": "Ranker", "type": "string", "enum": [ "auto", "default-2024-11-15" ] }, "score_threshold": { "title": "Score Threshold", "type": "number" } }, "additionalProperties": true, "type": "object", "title": "RankingOptions", "description": "Ranking options for search." }, "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." }, "Reasoning": { "properties": { "effort": { "title": "Effort", "type": "string", "enum": [ "none", "minimal", "low", "medium", "high", "xhigh" ] }, "generate_summary": { "title": "Generate Summary", "type": "string", "enum": [ "auto", "concise", "detailed" ] }, "summary": { "title": "Summary", "type": "string", "enum": [ "auto", "concise", "detailed" ] } }, "additionalProperties": true, "type": "object", "title": "Reasoning", "description": "**gpt-5 and o-series models only**\n\nConfiguration options for\n[reasoning models](https://platform.openai.com/docs/guides/reasoning)." }, "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" }, "created_by": { "title": "Created By", "type": "string" } }, "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" }, "created_by": { "title": "Created By", "type": "string" }, "output": { "title": "Output", "type": "string" } }, "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": { "type": "string", "title": "Code" }, "container_id": { "type": "string", "title": "Container Id" }, "outputs": { "title": "Outputs", "items": { "anyOf": [ { "$ref": "#/$defs/OutputLogs" }, { "$ref": "#/$defs/OutputImage" } ] }, "type": "array" }, "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." }, "ResponseCompactionItem": { "properties": { "id": { "type": "string", "title": "Id" }, "encrypted_content": { "type": "string", "title": "Encrypted Content" }, "type": { "type": "string", "const": "compaction", "title": "Type" }, "created_by": { "title": "Created By", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "id", "encrypted_content", "type" ], "title": "ResponseCompactionItem", "description": "A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact)." }, "ResponseCompactionItemParam": { "properties": { "encrypted_content": { "type": "string", "title": "Encrypted Content" }, "type": { "type": "string", "const": "compaction", "title": "Type" }, "id": { "type": "string", "title": "Id" } }, "additionalProperties": true, "type": "object", "required": [ "encrypted_content", "type" ], "title": "ResponseCompactionItemParam", "description": "A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact)." }, "ResponseComputerToolCall": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "anyOf": [ { "$ref": "#/$defs/ActionClick" }, { "$ref": "#/$defs/ActionDoubleClick" }, { "$ref": "#/$defs/ActionDrag" }, { "$ref": "#/$defs/ActionKeypress" }, { "$ref": "#/$defs/ActionMove" }, { "$ref": "#/$defs/ActionScreenshot" }, { "$ref": "#/$defs/ActionScroll" }, { "$ref": "#/$defs/ActionType" }, { "$ref": "#/$defs/ActionWait" } ], "title": "Action" }, "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" } }, "additionalProperties": true, "type": "object", "required": [ "id", "action", "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://platform.openai.com/docs/guides/tools-computer-use) for more information." }, "ResponseComputerToolCallOutputScreenshot": { "properties": { "type": { "type": "string", "const": "computer_screenshot", "title": "Type" }, "file_id": { "type": "string", "title": "File Id" }, "image_url": { "title": "Image Url", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseComputerToolCallOutputScreenshot", "description": "A computer screenshot image used with the computer use tool." }, "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": { "type": "string", "title": "Id" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "input", "name", "type" ], "title": "ResponseCustomToolCall", "description": "A call to a custom tool created by the model." }, "ResponseCustomToolCallOutput": { "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" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type" ], "title": "ResponseCustomToolCallOutput", "description": "The output of a custom tool call from your code, being sent back to the model." }, "ResponseError": { "properties": { "code": { "type": "string", "enum": [ "server_error", "rate_limit_exceeded", "invalid_prompt", "vector_store_timeout", "invalid_image", "invalid_image_format", "invalid_base64_image", "invalid_image_url", "image_too_large", "image_too_small", "image_parse_error", "image_content_policy_violation", "invalid_image_mode", "image_file_too_large", "unsupported_image_media_type", "empty_image_file", "failed_to_download_image", "image_file_not_found" ], "title": "Code" }, "message": { "type": "string", "title": "Message" } }, "additionalProperties": true, "type": "object", "required": [ "code", "message" ], "title": "ResponseError", "description": "An error object returned when the model fails to generate a Response." }, "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": { "title": "Results", "items": { "$ref": "#/$defs/openai__types__responses__response_file_search_tool_call__Result" }, "type": "array" } }, "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://platform.openai.com/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": { "title": "Description", "type": "string" }, "strict": { "title": "Strict", "type": "boolean" } }, "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://platform.openai.com/docs/guides/structured-outputs)." }, "ResponseFunctionShellCallOutputContent": { "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": "ResponseFunctionShellCallOutputContent", "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" } ], "title": "Environment" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "type": "string", "const": "shell_call", "title": "Type" }, "created_by": { "title": "Created By", "type": "string" } }, "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": { "title": "Max Output Length", "type": "integer" }, "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" }, "created_by": { "title": "Created By", "type": "string" } }, "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": { "title": "Arguments", "type": "string" }, "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" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "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://platform.openai.com/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" ], "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://platform.openai.com/docs/guides/tools-web-search) for more information." }, "ResponseInputFile": { "properties": { "type": { "type": "string", "const": "input_file", "title": "Type" }, "file_data": { "title": "File Data", "type": "string" }, "file_id": { "type": "string", "title": "File Id" }, "file_url": { "title": "File Url", "type": "string" }, "filename": { "type": "string", "title": "Filename" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseInputFile", "description": "A file input to the model." }, "ResponseInputFileContent": { "properties": { "type": { "type": "string", "const": "input_file", "title": "Type" }, "file_data": { "title": "File Data", "type": "string" }, "file_id": { "type": "string", "title": "File Id" }, "file_url": { "title": "File Url", "type": "string" }, "filename": { "type": "string", "title": "Filename" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseInputFileContent", "description": "A file input to the model." }, "ResponseInputImage": { "properties": { "detail": { "type": "string", "enum": [ "low", "high", "auto" ], "title": "Detail" }, "type": { "type": "string", "const": "input_image", "title": "Type" }, "file_id": { "type": "string", "title": "File Id" }, "image_url": { "title": "Image Url", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "detail", "type" ], "title": "ResponseInputImage", "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)." }, "ResponseInputImageContent": { "properties": { "type": { "type": "string", "const": "input_image", "title": "Type" }, "detail": { "type": "string", "enum": [ "low", "high", "auto" ], "title": "Detail" }, "file_id": { "type": "string", "title": "File Id" }, "image_url": { "title": "Image Url", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "ResponseInputImageContent", "description": "An image input to the model.\n\nLearn about [image inputs](https://platform.openai.com/docs/guides/vision)" }, "ResponseInputText": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "input_text", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "ResponseInputText", "description": "A text input to the model." }, "ResponseInputTextContent": { "properties": { "text": { "type": "string", "title": "Text" }, "type": { "type": "string", "const": "input_text", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "text", "type" ], "title": "ResponseInputTextContent", "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": { "title": "Type", "type": "string", "const": "message" }, "phase": { "title": "Phase", "type": "string", "enum": [ "commentary", "final_answer" ] } }, "additionalProperties": true, "type": "object", "required": [ "id", "content", "role", "status", "type" ], "title": "ResponseOutputMessage", "description": "An output message from the model." }, "ResponseOutputRefusal": { "properties": { "refusal": { "title": "Refusal", "type": "string" }, "type": { "type": "string", "const": "refusal", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "refusal", "type" ], "title": "ResponseOutputRefusal", "description": "A refusal from the model." }, "ResponseOutputText": { "properties": { "annotations": { "items": { "anyOf": [ { "$ref": "#/$defs/AnnotationFileCitation" }, { "$ref": "#/$defs/openai__types__responses__response_output_text__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": { "title": "Logprobs", "items": { "$ref": "#/$defs/openai__types__responses__response_output_text__Logprob" }, "type": "array" } }, "additionalProperties": true, "type": "object", "required": [ "annotations", "text", "type" ], "title": "ResponseOutputText", "description": "A text output from the model." }, "ResponsePrompt": { "properties": { "id": { "type": "string", "title": "Id" }, "variables": { "title": "Variables", "additionalProperties": { "anyOf": [ { "type": "string" }, { "$ref": "#/$defs/ResponseInputText" }, { "$ref": "#/$defs/ResponseInputImage" }, { "$ref": "#/$defs/ResponseInputFile" } ] }, "type": "object" }, "version": { "title": "Version", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "ResponsePrompt", "description": "Reference to a prompt template and its variables.\n[Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts)." }, "ResponseReasoningItem": { "properties": { "id": { "type": "string", "title": "Id" }, "summary": { "items": { "$ref": "#/$defs/Summary" }, "type": "array", "title": "Summary" }, "type": { "type": "string", "const": "reasoning", "title": "Type" }, "content": { "title": "Content", "items": { "$ref": "#/$defs/Content" }, "type": "array" }, "encrypted_content": { "type": "string", "title": "Encrypted Content" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "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://platform.openai.com/docs/guides/conversation-state)." }, "ResponseTextConfig": { "properties": { "format": { "anyOf": [ { "$ref": "#/$defs/ResponseFormatText" }, { "$ref": "#/$defs/ResponseFormatTextJSONSchemaConfig" }, { "$ref": "#/$defs/ResponseFormatJSONObject" } ], "title": "Format" }, "verbosity": { "title": "Verbosity", "type": "string", "enum": [ "low", "medium", "high" ] } }, "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://platform.openai.com/docs/guides/text)\n- [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)" }, "ResponseUsage": { "properties": { "input_tokens": { "type": "integer", "title": "Input Tokens" }, "input_tokens_details": { "$ref": "#/$defs/InputTokensDetails" }, "output_tokens": { "type": "integer", "title": "Output Tokens" }, "output_tokens_details": { "$ref": "#/$defs/OutputTokensDetails" }, "total_tokens": { "type": "integer", "title": "Total Tokens" } }, "additionalProperties": true, "type": "object", "required": [ "input_tokens", "input_tokens_details", "output_tokens", "output_tokens_details", "total_tokens" ], "title": "ResponseUsage", "description": "Represents token usage details including input tokens, output tokens,\na breakdown of output tokens, and the total tokens used." }, "SkillReference": { "properties": { "skill_id": { "type": "string", "title": "Skill Id" }, "type": { "type": "string", "const": "skill_reference", "title": "Type" }, "version": { "title": "Version", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "skill_id", "type" ], "title": "SkillReference" }, "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": { "type": "string", "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." }, "ToolChoiceTypes": { "properties": { "type": { "type": "string", "enum": [ "file_search", "web_search_preview", "computer_use_preview", "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://platform.openai.com/docs/guides/tools)." }, "WebSearchPreviewTool": { "properties": { "type": { "type": "string", "enum": [ "web_search_preview", "web_search_preview_2025_03_11" ], "title": "Type" }, "search_context_size": { "title": "Search Context Size", "type": "string", "enum": [ "low", "medium", "high" ] }, "user_location": { "$ref": "#/$defs/openai__types__responses__web_search_preview_tool__UserLocation" } }, "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://platform.openai.com/docs/guides/tools-web-search)." }, "WebSearchTool": { "properties": { "type": { "type": "string", "enum": [ "web_search", "web_search_2025_08_26" ], "title": "Type" }, "filters": { "$ref": "#/$defs/Filters" }, "search_context_size": { "title": "Search Context Size", "type": "string", "enum": [ "low", "medium", "high" ] }, "user_location": { "$ref": "#/$defs/openai__types__responses__web_search_tool__UserLocation" } }, "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://platform.openai.com/docs/guides/tools-web-search)." }, "openai__types__responses__response_computer_tool_call__PendingSafetyCheck": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "type": "string", "title": "Code" }, "message": { "type": "string", "title": "Message" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "PendingSafetyCheck", "description": "A pending safety check for the computer call." }, "openai__types__responses__response_file_search_tool_call__Result": { "properties": { "attributes": { "title": "Attributes", "additionalProperties": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] }, "type": "object" }, "file_id": { "type": "string", "title": "File Id" }, "filename": { "type": "string", "title": "Filename" }, "score": { "title": "Score", "type": "number" }, "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": { "type": "string", "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": { "query": { "type": "string", "title": "Query" }, "type": { "type": "string", "const": "search", "title": "Type" }, "queries": { "items": { "type": "string" }, "type": "array", "title": "Queries" }, "sources": { "title": "Sources", "items": { "$ref": "#/$defs/ActionSearchSource" }, "type": "array" } }, "additionalProperties": true, "type": "object", "required": [ "query", "type" ], "title": "ActionSearch", "description": "Action type \"search\" - Performs a web search query." }, "openai__types__responses__response_input_item__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": { "type": "string", "title": "Id" } }, "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." }, "openai__types__responses__response_input_item__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": { "type": "string", "title": "Id" }, "output": { "title": "Output", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "status", "type" ], "title": "ApplyPatchCallOutput", "description": "The streamed output emitted by an apply patch tool call." }, "openai__types__responses__response_input_item__ComputerCallOutput": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "output": { "$ref": "#/$defs/ResponseComputerToolCallOutputScreenshot" }, "type": { "type": "string", "const": "computer_call_output", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "acknowledged_safety_checks": { "title": "Acknowledged Safety Checks", "items": { "$ref": "#/$defs/openai__types__responses__response_input_item__ComputerCallOutputAcknowledgedSafetyCheck" }, "type": "array" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type" ], "title": "ComputerCallOutput", "description": "The output of a computer tool call." }, "openai__types__responses__response_input_item__ComputerCallOutputAcknowledgedSafetyCheck": { "properties": { "id": { "type": "string", "title": "Id" }, "code": { "type": "string", "title": "Code" }, "message": { "type": "string", "title": "Message" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "ComputerCallOutputAcknowledgedSafetyCheck", "description": "A pending safety check for the computer call." }, "openai__types__responses__response_input_item__FunctionCallOutput": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "output": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputTextContent" }, { "$ref": "#/$defs/ResponseInputImageContent" }, { "$ref": "#/$defs/ResponseInputFileContent" } ] }, "type": "array" } ], "title": "Output" }, "type": { "type": "string", "const": "function_call_output", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type" ], "title": "FunctionCallOutput", "description": "The output of a function tool call." }, "openai__types__responses__response_input_item__ImageGenerationCall": { "properties": { "id": { "type": "string", "title": "Id" }, "result": { "type": "string", "title": "Result" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "generating", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "image_generation_call", "title": "Type" } }, "additionalProperties": true, "type": "object", "required": [ "id", "status", "type" ], "title": "ImageGenerationCall", "description": "An image generation request made by the model." }, "openai__types__responses__response_input_item__ItemReference": { "properties": { "id": { "type": "string", "title": "Id" }, "type": { "title": "Type", "type": "string", "const": "item_reference" } }, "additionalProperties": true, "type": "object", "required": [ "id" ], "title": "ItemReference", "description": "An internal identifier for an item to reference." }, "openai__types__responses__response_input_item__LocalShellCall": { "properties": { "id": { "type": "string", "title": "Id" }, "action": { "$ref": "#/$defs/openai__types__responses__response_input_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_input_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": { "title": "Timeout Ms", "type": "integer" }, "user": { "title": "User", "type": "string" }, "working_directory": { "title": "Working Directory", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "command", "env", "type" ], "title": "LocalShellCallAction", "description": "Execute a shell command on the server." }, "openai__types__responses__response_input_item__LocalShellCallOutput": { "properties": { "id": { "type": "string", "title": "Id" }, "output": { "title": "Output", "type": "string" }, "type": { "type": "string", "const": "local_shell_call_output", "title": "Type" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "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__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": { "type": "string", "title": "Id" }, "reason": { "title": "Reason", "type": "string" } }, "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__McpCall": { "properties": { "id": { "type": "string", "title": "Id" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "type": "string", "title": "Name" }, "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp_call", "title": "Type" }, "approval_request_id": { "type": "string", "title": "Approval Request Id" }, "error": { "title": "Error", "type": "string" }, "output": { "title": "Output", "type": "string" }, "status": { "title": "Status", "type": "string", "enum": [ "in_progress", "completed", "incomplete", "calling", "failed" ] } }, "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__McpListTools": { "properties": { "id": { "type": "string", "title": "Id" }, "server_label": { "type": "string", "title": "Server Label" }, "tools": { "items": { "$ref": "#/$defs/openai__types__responses__response_input_item__McpListToolsTool" }, "type": "array", "title": "Tools" }, "type": { "type": "string", "const": "mcp_list_tools", "title": "Type" }, "error": { "title": "Error", "type": "string" } }, "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__McpListToolsTool": { "properties": { "input_schema": { "title": "Input Schema" }, "name": { "type": "string", "title": "Name" }, "annotations": { "title": "Annotations" }, "description": { "title": "Description", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "input_schema", "name" ], "title": "McpListToolsTool", "description": "A tool available on an MCP server." }, "openai__types__responses__response_input_item__Message": { "properties": { "content": { "items": { "anyOf": [ { "$ref": "#/$defs/ResponseInputText" }, { "$ref": "#/$defs/ResponseInputImage" }, { "$ref": "#/$defs/ResponseInputFile" } ] }, "type": "array", "title": "Content" }, "role": { "type": "string", "enum": [ "user", "system", "developer" ], "title": "Role" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" }, "type": { "title": "Type", "type": "string", "const": "message" } }, "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_input_item__ShellCall": { "properties": { "action": { "$ref": "#/$defs/openai__types__responses__response_input_item__ShellCallAction" }, "call_id": { "type": "string", "title": "Call Id" }, "type": { "type": "string", "const": "shell_call", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "environment": { "anyOf": [ { "$ref": "#/$defs/LocalEnvironment" }, { "$ref": "#/$defs/ContainerReference" } ], "title": "Environment" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "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." }, "openai__types__responses__response_input_item__ShellCallAction": { "properties": { "commands": { "items": { "type": "string" }, "type": "array", "title": "Commands" }, "max_output_length": { "title": "Max Output Length", "type": "integer" }, "timeout_ms": { "title": "Timeout Ms", "type": "integer" } }, "additionalProperties": true, "type": "object", "required": [ "commands" ], "title": "ShellCallAction", "description": "The shell commands and limits that describe how to run the tool call." }, "openai__types__responses__response_input_item__ShellCallOutput": { "properties": { "call_id": { "type": "string", "title": "Call Id" }, "output": { "items": { "$ref": "#/$defs/ResponseFunctionShellCallOutputContent" }, "type": "array", "title": "Output" }, "type": { "type": "string", "const": "shell_call_output", "title": "Type" }, "id": { "type": "string", "title": "Id" }, "max_output_length": { "title": "Max Output Length", "type": "integer" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "incomplete" ], "title": "Status" } }, "additionalProperties": true, "type": "object", "required": [ "call_id", "output", "type" ], "title": "ShellCallOutput", "description": "The streamed output items emitted by a shell tool call." }, "openai__types__responses__response_output_item__ImageGenerationCall": { "properties": { "id": { "type": "string", "title": "Id" }, "result": { "type": "string", "title": "Result" }, "status": { "type": "string", "enum": [ "in_progress", "completed", "generating", "failed" ], "title": "Status" }, "type": { "type": "string", "const": "image_generation_call", "title": "Type" } }, "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__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": { "title": "Timeout Ms", "type": "integer" }, "user": { "title": "User", "type": "string" }, "working_directory": { "title": "Working Directory", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "command", "env", "type" ], "title": "LocalShellCallAction", "description": "Execute a shell command on the server." }, "openai__types__responses__response_output_item__McpCall": { "properties": { "id": { "type": "string", "title": "Id" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "type": "string", "title": "Name" }, "server_label": { "type": "string", "title": "Server Label" }, "type": { "type": "string", "const": "mcp_call", "title": "Type" }, "approval_request_id": { "type": "string", "title": "Approval Request Id" }, "error": { "title": "Error", "type": "string" }, "output": { "title": "Output", "type": "string" }, "status": { "title": "Status", "type": "string", "enum": [ "in_progress", "completed", "incomplete", "calling", "failed" ] } }, "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": { "title": "Error", "type": "string" } }, "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": { "title": "Annotations" }, "description": { "title": "Description", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "input_schema", "name" ], "title": "McpListToolsTool", "description": "A tool available on an MCP server." }, "openai__types__responses__response_output_text__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." }, "openai__types__responses__response_output_text__Logprob": { "properties": { "token": { "type": "string", "title": "Token" }, "bytes": { "title": "Bytes", "items": { "type": "integer" }, "type": "array" }, "logprob": { "type": "number", "title": "Logprob" }, "top_logprobs": { "items": { "$ref": "#/$defs/openai__types__responses__response_output_text__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." }, "openai__types__responses__response_output_text__LogprobTopLogprob": { "properties": { "token": { "type": "string", "title": "Token" }, "bytes": { "title": "Bytes", "items": { "type": "integer" }, "type": "array" }, "logprob": { "type": "number", "title": "Logprob" } }, "additionalProperties": true, "type": "object", "required": [ "token", "bytes", "logprob" ], "title": "LogprobTopLogprob", "description": "The top log probability of a token." }, "openai__types__responses__web_search_preview_tool__UserLocation": { "properties": { "type": { "type": "string", "const": "approximate", "title": "Type" }, "city": { "title": "City", "type": "string" }, "country": { "title": "Country", "type": "string" }, "region": { "title": "Region", "type": "string" }, "timezone": { "title": "Timezone", "type": "string" } }, "additionalProperties": true, "type": "object", "required": [ "type" ], "title": "UserLocation", "description": "The user's location." }, "openai__types__responses__web_search_tool__UserLocation": { "properties": { "city": { "title": "City", "type": "string" }, "country": { "title": "Country", "type": "string" }, "region": { "title": "Region", "type": "string" }, "timezone": { "title": "Timezone", "type": "string" }, "type": { "type": "string", "const": "approximate", "title": "Type" } }, "additionalProperties": true, "type": "object", "title": "UserLocation", "description": "The approximate location of the user." } } }