> ## Documentation Index > Fetch the complete documentation index at: https://docs.tokenfactory.nebius.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a response > Creates a model response for a given input ## OpenAPI ````yaml https://api.tokenfactory.nebius.com/openapi.json post /v1/responses openapi: 3.1.0 info: title: Nebius OpenAI-compatible inference API version: 20260630-e4a4e27f2 servers: - url: https://api.tokenfactory.nebius.com security: [] paths: /v1/responses: post: tags: - inference summary: Create a response description: Creates a model response for a given input operationId: create_response_v1_responses_post parameters: - name: ai_project_id in: query required: false schema: anyOf: - type: string - type: 'null' description: current project ID title: Ai Project Id description: current project ID requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateResponseRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponsesResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: CreateResponseRequest: properties: background: anyOf: - type: boolean - type: 'null' title: Background description: Whether to run the model response in the background. examples: - 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 description: Specify additional output data to include in the model response. input: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/EasyInputMessage' - $ref: '#/components/schemas/Message' - $ref: '#/components/schemas/ResponseOutputMessage' - $ref: '#/components/schemas/ResponseFileSearchToolCall' - $ref: '#/components/schemas/ResponseComputerToolCall' - $ref: '#/components/schemas/ComputerCallOutput' - $ref: '#/components/schemas/ResponseFunctionWebSearch' - $ref: '#/components/schemas/ResponseFunctionToolCall' - $ref: '#/components/schemas/FunctionCallOutput' - $ref: '#/components/schemas/ToolSearchCall' - $ref: '#/components/schemas/ResponseToolSearchOutputItemParam' - $ref: >- #/components/schemas/openai__types__responses__response_input_item__AdditionalTools - $ref: '#/components/schemas/ResponseReasoningItem' - $ref: '#/components/schemas/ResponseCompactionItemParam' - $ref: '#/components/schemas/ImageGenerationCall' - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall' - $ref: '#/components/schemas/LocalShellCall' - $ref: '#/components/schemas/LocalShellCallOutput' - $ref: '#/components/schemas/ShellCall' - $ref: '#/components/schemas/ShellCallOutput' - $ref: '#/components/schemas/ApplyPatchCall' - $ref: '#/components/schemas/ApplyPatchCallOutput' - $ref: '#/components/schemas/McpListTools' - $ref: '#/components/schemas/McpApprovalRequest' - $ref: >- #/components/schemas/openai__types__responses__response_input_item__McpApprovalResponse - $ref: '#/components/schemas/McpCall' - $ref: '#/components/schemas/ResponseCustomToolCallOutput' - $ref: '#/components/schemas/ResponseCustomToolCall' - $ref: '#/components/schemas/CompactionTrigger' - $ref: '#/components/schemas/ItemReference' - $ref: '#/components/schemas/ResponseFunctionToolCallOutputItem' - $ref: '#/components/schemas/ResponseComputerToolCallOutputItem' - $ref: '#/components/schemas/ResponseToolSearchCall' - $ref: '#/components/schemas/ResponseToolSearchOutputItem' - $ref: >- #/components/schemas/openai__types__responses__response_output_item__AdditionalTools - $ref: '#/components/schemas/ResponseCompactionItem' - $ref: '#/components/schemas/ImageGenerationCall' - $ref: '#/components/schemas/LocalShellCall' - $ref: '#/components/schemas/LocalShellCallOutput' - $ref: '#/components/schemas/ResponseFunctionShellToolCall' - $ref: '#/components/schemas/ResponseFunctionShellToolCallOutput' - $ref: '#/components/schemas/ResponseApplyPatchToolCall' - $ref: '#/components/schemas/ResponseApplyPatchToolCallOutput' - $ref: '#/components/schemas/McpCall' - $ref: '#/components/schemas/McpListTools' - $ref: '#/components/schemas/McpApprovalRequest' - $ref: >- #/components/schemas/openai__types__responses__response_output_item__McpApprovalResponse - $ref: '#/components/schemas/ResponseCustomToolCallOutputItem' type: array title: Input description: >- Text, image, or file inputs to the model, used to generate a response. instructions: anyOf: - type: string - type: 'null' title: Instructions description: A system (or developer) message inserted into the model's context. max_output_tokens: anyOf: - type: integer - type: 'null' title: Max Output Tokens description: >- An upper bound for the number of tokens that can be generated for a response, including visible output tokens and reasoning tokens. max_tool_calls: anyOf: - type: integer - type: 'null' title: Max Tool Calls description: >- The maximum number of total calls to built-in tools that can be processed in a response. This maximum number applies across all built-in tool calls, not per individual tool. Any further attempts to call a tool by the model will be ignored. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: Set of 16 key-value pairs that can be attached to an object. model: type: string title: Model description: The model used for the chat completion. parallel_tool_calls: anyOf: - type: boolean - type: 'null' title: Parallel Tool Calls description: Whether to allow the model to run tool calls in parallel. previous_response_id: anyOf: - type: string - type: 'null' title: Previous Response Id description: The unique ID of the previous response to the model. prompt: anyOf: - $ref: '#/components/schemas/ResponsePrompt' - type: 'null' description: Reference to a prompt template and its variables. reasoning: anyOf: - $ref: '#/components/schemas/Reasoning' - type: 'null' description: Configuration options for reasoning models. service_tier: $ref: '#/components/schemas/ServiceTier' description: The service tier to use for the request. default: auto examples: - auto - flex store: anyOf: - type: boolean - type: 'null' title: Store description: >- Whether to store the generated model response for later retrieval via API. stream: anyOf: - type: boolean - type: 'null' title: Stream description: >- If set to true, the model response data will be streamed to the client as it is generated using server-sent events. temperature: anyOf: - type: number maximum: 2 minimum: 0 - type: 'null' title: Temperature description: >- What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or `top_p` but not both. default: 1 text: anyOf: - $ref: '#/components/schemas/ResponseTextConfig' - type: 'null' description: Configuration options for a text response from the model. tool_choice: anyOf: - type: string enum: - none - auto - required - $ref: '#/components/schemas/ToolChoiceAllowed' - $ref: '#/components/schemas/ToolChoiceTypes' - $ref: '#/components/schemas/ToolChoiceFunction' - $ref: '#/components/schemas/ToolChoiceMcp' - $ref: '#/components/schemas/ToolChoiceCustom' - $ref: '#/components/schemas/ToolChoiceApplyPatch' - $ref: '#/components/schemas/ToolChoiceShell' title: Tool Choice description: >- How the model should select which tool (or tools) to use when generating a response. default: auto tools: items: anyOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' type: array title: Tools description: An array of tools the model may call while generating a response. top_logprobs: anyOf: - type: integer minimum: 0 - type: 'null' title: Top Logprobs description: >- A non-negative integer specifying the number of most likely tokens to return at each token position, each with an associated log probability. `logprobs` must be set to `true` if this parameter is used. top_p: anyOf: - type: number maximum: 1 minimum: 0 - type: 'null' title: Top P description: >- An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or `temperature` but not both. truncation: type: string enum: - auto - disabled title: Truncation description: The truncation strategy to use for the model response. default: disabled user: anyOf: - type: string - type: 'null' title: User description: >- A unique identifier representing your end-user, which can help us to monitor and detect abuse. [Learn more](https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids). prompt_cache_key: anyOf: - type: string - type: 'null' title: Prompt Cache Key description: >- Used by OpenAI to cache responses for similar requests to optimize your cache hit rates. Replaces the user field. additionalProperties: true type: object required: - input - model title: CreateResponseRequest ResponsesResponse: properties: id: type: string title: Id created_at: type: integer title: Created At error: anyOf: - $ref: '#/components/schemas/ResponseError' - type: 'null' incomplete_details: anyOf: - $ref: '#/components/schemas/IncompleteDetails' - type: 'null' instructions: anyOf: - type: string - type: 'null' title: Instructions metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata model: type: string title: Model object: type: string const: response title: Object default: response output: items: anyOf: - $ref: '#/components/schemas/ResponseOutputMessage' - $ref: '#/components/schemas/ResponseFileSearchToolCall' - $ref: '#/components/schemas/ResponseFunctionToolCall' - $ref: '#/components/schemas/ResponseFunctionToolCallOutputItem' - $ref: '#/components/schemas/ResponseFunctionWebSearch' - $ref: '#/components/schemas/ResponseComputerToolCall' - $ref: '#/components/schemas/ResponseComputerToolCallOutputItem' - $ref: '#/components/schemas/ResponseReasoningItem' - $ref: '#/components/schemas/ResponseToolSearchCall' - $ref: '#/components/schemas/ResponseToolSearchOutputItem' - $ref: '#/components/schemas/AdditionalTools-Output' - $ref: '#/components/schemas/ResponseCompactionItem' - $ref: '#/components/schemas/ImageGenerationCall' - $ref: '#/components/schemas/ResponseCodeInterpreterToolCall' - $ref: '#/components/schemas/LocalShellCall' - $ref: '#/components/schemas/LocalShellCallOutput' - $ref: '#/components/schemas/ResponseFunctionShellToolCall' - $ref: '#/components/schemas/ResponseFunctionShellToolCallOutput' - $ref: '#/components/schemas/ResponseApplyPatchToolCall' - $ref: '#/components/schemas/ResponseApplyPatchToolCallOutput' - $ref: '#/components/schemas/McpCall' - $ref: '#/components/schemas/McpListTools' - $ref: '#/components/schemas/McpApprovalRequest' - $ref: '#/components/schemas/McpApprovalResponse-Output' - $ref: '#/components/schemas/ResponseCustomToolCall' - $ref: '#/components/schemas/ResponseCustomToolCallOutputItem' type: array title: Output parallel_tool_calls: type: boolean title: Parallel Tool Calls temperature: type: number title: Temperature tool_choice: anyOf: - type: string enum: - none - auto - required - $ref: '#/components/schemas/ToolChoiceAllowed' - $ref: '#/components/schemas/ToolChoiceTypes' - $ref: '#/components/schemas/ToolChoiceFunction' - $ref: '#/components/schemas/ToolChoiceMcp' - $ref: '#/components/schemas/ToolChoiceCustom' - $ref: '#/components/schemas/ToolChoiceApplyPatch' - $ref: '#/components/schemas/ToolChoiceShell' title: Tool Choice tools: items: anyOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' type: array title: Tools top_p: type: number title: Top P background: type: boolean title: Background max_output_tokens: type: integer title: Max Output Tokens max_tool_calls: anyOf: - type: integer - type: 'null' title: Max Tool Calls previous_response_id: anyOf: - type: string - type: 'null' title: Previous Response Id prompt: anyOf: - $ref: '#/components/schemas/ResponsePrompt' - type: 'null' reasoning: anyOf: - $ref: '#/components/schemas/Reasoning' - type: 'null' service_tier: $ref: '#/components/schemas/ServiceTier' status: type: string enum: - completed - failed - in_progress - cancelled - queued - incomplete title: Status text: anyOf: - $ref: '#/components/schemas/ResponseTextConfig' - type: 'null' top_logprobs: anyOf: - type: integer - type: 'null' title: Top Logprobs truncation: type: string enum: - auto - disabled title: Truncation usage: anyOf: - $ref: '#/components/schemas/ResponseUsage' - type: 'null' user: anyOf: - type: string - type: 'null' title: User type: object required: - id - created_at - model - output - parallel_tool_calls - temperature - tool_choice - tools - top_p - background - max_output_tokens - service_tier - status - truncation title: ResponsesResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError EasyInputMessage: properties: content: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' 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: anyOf: - type: string const: message - type: 'null' title: Type additionalProperties: true type: object required: - content - role title: EasyInputMessage description: >- A message input to the model with a role indicating instruction following hierarchy. Instructions given with the `developer` or `system` role take precedence over instructions given with the `user` role. Messages with the `assistant` role are presumed to have been generated by the model in previous interactions. Message: properties: content: items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' type: array title: Content role: type: string enum: - user - system - developer title: Role status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status type: anyOf: - type: string const: message - type: 'null' title: Type additionalProperties: true type: object required: - content - role title: Message description: >- A message input to the model with a role indicating instruction following hierarchy. Instructions given with the `developer` or `system` role take precedence over instructions given with the `user` role. ResponseOutputMessage: properties: id: type: string title: Id content: items: anyOf: - $ref: '#/components/schemas/ResponseOutputText' - $ref: '#/components/schemas/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. 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: '#/components/schemas/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. See the [file search guide](https://platform.openai.com/docs/guides/tools-file-search) for more information. ResponseComputerToolCall: properties: id: type: string title: Id call_id: type: string title: Call Id pending_safety_checks: items: $ref: '#/components/schemas/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: '#/components/schemas/ActionClick' - $ref: '#/components/schemas/ActionDoubleClick' - $ref: '#/components/schemas/ActionDrag' - $ref: '#/components/schemas/ActionKeypress' - $ref: '#/components/schemas/ActionMove' - $ref: '#/components/schemas/ActionScreenshot' - $ref: '#/components/schemas/ActionScroll' - $ref: '#/components/schemas/ActionType' - $ref: '#/components/schemas/ActionWait' - type: 'null' title: Action actions: anyOf: - items: anyOf: - $ref: '#/components/schemas/Click' - $ref: '#/components/schemas/DoubleClick' - $ref: '#/components/schemas/Drag' - $ref: '#/components/schemas/Keypress' - $ref: '#/components/schemas/Move' - $ref: '#/components/schemas/Screenshot' - $ref: '#/components/schemas/Scroll' - $ref: '#/components/schemas/Type' - $ref: '#/components/schemas/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. See the [computer use guide](https://platform.openai.com/docs/guides/tools-computer-use) for more information. ComputerCallOutput: properties: call_id: type: string title: Call Id output: $ref: '#/components/schemas/ResponseComputerToolCallOutputScreenshot' type: type: string const: computer_call_output title: Type id: anyOf: - type: string - type: 'null' title: Id acknowledged_safety_checks: anyOf: - items: $ref: '#/components/schemas/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. ResponseFunctionWebSearch: properties: id: type: string title: Id action: anyOf: - $ref: '#/components/schemas/ActionSearch' - $ref: '#/components/schemas/ActionOpenPage' - $ref: '#/components/schemas/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. See the [web search guide](https://platform.openai.com/docs/guides/tools-web-search) for more information. 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 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. See the [function calling guide](https://platform.openai.com/docs/guides/function-calling) for more information. FunctionCallOutput: properties: call_id: type: string title: Call Id output: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputTextContent' - $ref: '#/components/schemas/ResponseInputImageContent' - $ref: '#/components/schemas/ResponseInputFileContent' type: array title: Output type: type: string const: function_call_output title: Type id: anyOf: - type: string - type: 'null' title: Id status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - call_id - output - type title: FunctionCallOutput description: The output of a function tool call. 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: anyOf: - type: string enum: - server - client - type: 'null' title: Execution status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - arguments - type title: ToolSearchCall ResponseToolSearchOutputItemParam: properties: tools: items: anyOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' 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: anyOf: - type: string enum: - server - client - type: 'null' title: Execution status: anyOf: - type: string enum: - in_progress - completed - incomplete - type: 'null' title: Status additionalProperties: true type: object required: - tools - type title: ResponseToolSearchOutputItemParam openai__types__responses__response_input_item__AdditionalTools: properties: role: type: string const: developer title: Role tools: items: anyOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' 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 ResponseReasoningItem: properties: id: type: string title: Id summary: items: $ref: '#/components/schemas/Summary' type: array title: Summary type: type: string const: reasoning title: Type content: anyOf: - items: $ref: '#/components/schemas/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 a response. Be sure to include these items in your `input` to the Responses API for subsequent turns of a conversation if you are manually [managing context](https://platform.openai.com/docs/guides/conversation-state). ResponseCompactionItemParam: 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: ResponseCompactionItemParam description: >- A compaction item generated by the [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact). 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 additionalProperties: true type: object required: - id - status - type title: ImageGenerationCall description: An image generation request made by the model. 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: '#/components/schemas/OutputLogs' - $ref: '#/components/schemas/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. LocalShellCall: properties: id: type: string title: Id action: $ref: '#/components/schemas/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. 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. ShellCall: properties: action: $ref: '#/components/schemas/ShellCallAction' call_id: type: string title: Call Id type: type: string const: shell_call title: Type id: anyOf: - type: string - type: 'null' title: Id environment: anyOf: - $ref: '#/components/schemas/LocalEnvironment' - $ref: '#/components/schemas/ContainerReference' - 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. ShellCallOutput: properties: call_id: type: string title: Call Id output: items: $ref: '#/components/schemas/ResponseFunctionShellCallOutputContent' type: array title: Output type: type: string const: shell_call_output title: Type id: anyOf: - type: string - type: 'null' title: Id 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. ApplyPatchCall: properties: call_id: type: string title: Call Id operation: anyOf: - $ref: '#/components/schemas/ApplyPatchCallOperationCreateFile' - $ref: '#/components/schemas/ApplyPatchCallOperationDeleteFile' - $ref: '#/components/schemas/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 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. 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 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. McpListTools: properties: id: type: string title: Id server_label: type: string title: Server Label tools: items: $ref: '#/components/schemas/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. 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. 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: 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. 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: - type: string - 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. ResponseCustomToolCallOutput: properties: call_id: type: string title: Call Id output: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' type: array title: Output type: type: string const: custom_tool_call_output title: Type id: anyOf: - type: string - type: 'null' 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. 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 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. 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. 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. ResponseFunctionToolCallOutputItem: properties: id: type: string title: Id call_id: type: string title: Call Id output: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' type: array title: Output status: type: string enum: - in_progress - completed - incomplete title: Status type: type: string const: function_call_output title: Type created_by: anyOf: - type: string - type: 'null' title: Created By additionalProperties: true type: object required: - id - call_id - output - status - type title: ResponseFunctionToolCallOutputItem ResponseComputerToolCallOutputItem: properties: id: type: string title: Id call_id: type: string title: Call Id output: $ref: '#/components/schemas/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: '#/components/schemas/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 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: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/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 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: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' type: array title: Tools type: type: string const: additional_tools title: Type additionalProperties: true type: object required: - id - role - tools - type title: AdditionalTools 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://platform.openai.com/docs/api-reference/responses/compact). ResponseFunctionShellToolCall: properties: id: type: string title: Id action: $ref: '#/components/schemas/Action' call_id: type: string title: Call Id environment: anyOf: - $ref: '#/components/schemas/ResponseLocalEnvironment' - $ref: '#/components/schemas/ResponseContainerReference' - type: 'null' title: Environment status: type: string enum: - in_progress - completed - incomplete title: Status type: type: string const: shell_call title: Type 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: '#/components/schemas/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: 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. ResponseApplyPatchToolCall: properties: id: type: string title: Id call_id: type: string title: Call Id operation: anyOf: - $ref: '#/components/schemas/OperationCreateFile' - $ref: '#/components/schemas/OperationDeleteFile' - $ref: '#/components/schemas/OperationUpdateFile' title: Operation status: type: string enum: - in_progress - completed title: Status type: type: string const: apply_patch_call title: Type 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 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. 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. ResponseCustomToolCallOutputItem: properties: call_id: type: string title: Call Id output: anyOf: - type: string - items: anyOf: - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/ResponseInputFile' type: array title: Output type: type: string const: custom_tool_call_output title: Type id: type: string title: Id 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. ResponsePrompt: properties: id: type: string title: Id variables: anyOf: - additionalProperties: anyOf: - type: string - $ref: '#/components/schemas/ResponseInputText' - $ref: '#/components/schemas/ResponseInputImage' - $ref: '#/components/schemas/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. [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts). Reasoning: properties: effort: anyOf: - type: string enum: - none - minimal - low - medium - high - xhigh - type: 'null' title: Effort generate_summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' title: Generate Summary summary: anyOf: - type: string enum: - auto - concise - detailed - type: 'null' title: Summary additionalProperties: true type: object title: Reasoning description: |- **gpt-5 and o-series models only** Configuration options for [reasoning models](https://platform.openai.com/docs/guides/reasoning). ServiceTier: type: string enum: - auto - default - over-limit - flex - no-limit title: ServiceTier description: |- Represents the service tier for requests. Attributes: Auto: Automatically choose the best available tier for the request (Default or OverLimit). Analyze response to determine which tier was used. Default: Return 429 errors on hitting the rate limit, do not exceed to the OverLimit tier. OverLimit: Indicate that the request was over the user limit. This tier cannot be set by user in the request, but us used in a response for tier=Auto. Flex: Do not consume rate-limit credits, but run with lower priority. May still result in 429 errors in case of if there is no resources to process. ResponseTextConfig: properties: format: anyOf: - $ref: '#/components/schemas/ResponseFormatText' - $ref: '#/components/schemas/ResponseFormatTextJSONSchemaConfig' - $ref: '#/components/schemas/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. Can be plain text or structured JSON data. Learn more: - [Text inputs and outputs](https://platform.openai.com/docs/guides/text) - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs) 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. 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. [Learn more about built-in tools](https://platform.openai.com/docs/guides/tools). 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. 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. 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. 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. 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 defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: anyOf: - type: string - type: 'null' title: Description additionalProperties: true type: object required: - name - type title: FunctionTool description: >- Defines a function in your own code the model can choose to call. Learn more about [function calling](https://platform.openai.com/docs/guides/function-calling). 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: '#/components/schemas/ComparisonFilter' - $ref: '#/components/schemas/CompoundFilter' - type: 'null' title: Filters max_num_results: anyOf: - type: integer - type: 'null' title: Max Num Results ranking_options: anyOf: - $ref: '#/components/schemas/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. Learn more about the [file search tool](https://platform.openai.com/docs/guides/tools-file-search). 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. Learn more about the [computer tool](https://platform.openai.com/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. Learn more about the [computer tool](https://platform.openai.com/docs/guides/tools-computer-use). WebSearchTool: properties: type: type: string enum: - web_search - web_search_2025_08_26 title: Type filters: anyOf: - $ref: '#/components/schemas/Filters' - type: 'null' search_context_size: anyOf: - type: string enum: - low - medium - high - type: 'null' title: Search Context Size user_location: anyOf: - $ref: >- #/components/schemas/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. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). 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: '#/components/schemas/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: '#/components/schemas/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 additionalProperties: true type: object required: - server_label - type title: Mcp description: >- Give the model access to additional tools via remote Model Context Protocol (MCP) servers. [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp). CodeInterpreter: properties: container: anyOf: - type: string - $ref: >- #/components/schemas/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. 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: '#/components/schemas/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-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 - 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. 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. FunctionShellTool: properties: type: type: string const: shell title: Type environment: anyOf: - $ref: '#/components/schemas/ContainerAuto' - $ref: '#/components/schemas/LocalEnvironment' - $ref: '#/components/schemas/ContainerReference' - type: 'null' title: Environment additionalProperties: true type: object required: - type title: FunctionShellTool description: A tool that allows the model to execute shell commands. CustomTool: properties: name: type: string title: Name type: type: string const: custom title: Type defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: anyOf: - type: string - type: 'null' title: Description format: anyOf: - $ref: '#/components/schemas/Text' - $ref: '#/components/schemas/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. Learn more about [custom tools](https://platform.openai.com/docs/guides/function-calling#custom-tools) NamespaceTool: properties: description: type: string title: Description name: type: string title: Name tools: items: anyOf: - $ref: '#/components/schemas/ToolFunction' - $ref: '#/components/schemas/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. 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. 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: >- #/components/schemas/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. Learn more about the [web search tool](https://platform.openai.com/docs/guides/tools-web-search). 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. 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. IncompleteDetails: properties: reason: anyOf: - type: string enum: - max_output_tokens - content_filter - type: 'null' title: Reason additionalProperties: true type: object title: IncompleteDetails description: Details about why the response is incomplete. AdditionalTools-Output: properties: id: type: string title: Id role: type: string enum: - unknown - user - assistant - system - critic - discriminator - developer - tool title: Role tools: items: anyOf: - $ref: '#/components/schemas/FunctionTool' - $ref: '#/components/schemas/FileSearchTool' - $ref: '#/components/schemas/ComputerTool' - $ref: '#/components/schemas/ComputerUsePreviewTool' - $ref: '#/components/schemas/WebSearchTool' - $ref: '#/components/schemas/Mcp' - $ref: '#/components/schemas/CodeInterpreter' - $ref: '#/components/schemas/ImageGeneration' - $ref: '#/components/schemas/LocalShell' - $ref: '#/components/schemas/FunctionShellTool' - $ref: '#/components/schemas/CustomTool' - $ref: '#/components/schemas/NamespaceTool' - $ref: '#/components/schemas/ToolSearchTool' - $ref: '#/components/schemas/WebSearchPreviewTool' - $ref: '#/components/schemas/ApplyPatchTool' type: array title: Tools type: type: string const: additional_tools title: Type additionalProperties: true type: object required: - id - role - tools - type title: AdditionalTools McpApprovalResponse-Output: 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. ResponseUsage: properties: input_tokens: type: integer title: Input Tokens input_tokens_details: $ref: '#/components/schemas/InputTokensDetails' output_tokens: type: integer title: Output Tokens output_tokens_details: $ref: '#/components/schemas/OutputTokensDetails' total_tokens: type: integer title: Total Tokens type: object required: - input_tokens - input_tokens_details - output_tokens - output_tokens_details - total_tokens title: ResponseUsage ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError 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. 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 additionalProperties: true type: object required: - detail - type title: ResponseInputImage description: >- An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision). ResponseInputFile: properties: type: type: string const: input_file title: Type detail: anyOf: - type: string enum: - high - low - 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 additionalProperties: true type: object required: - type title: ResponseInputFile description: A file input to the model. ResponseOutputText: properties: annotations: items: anyOf: - $ref: '#/components/schemas/AnnotationFileCitation' - $ref: '#/components/schemas/AnnotationURLCitation' - $ref: '#/components/schemas/AnnotationContainerFileCitation' - $ref: '#/components/schemas/AnnotationFilePath' type: array title: Annotations text: type: string title: Text type: type: string const: output_text title: Type logprobs: anyOf: - items: $ref: '#/components/schemas/Logprob' type: array - type: 'null' title: Logprobs additionalProperties: true type: object required: - annotations - text - type title: ResponseOutputText description: A text output 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. 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 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. 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. 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. ActionDrag: properties: path: items: $ref: '#/components/schemas/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. 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' 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. 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' 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. 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. 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. 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. Drag: properties: path: items: $ref: '#/components/schemas/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. 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. 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. Screenshot: properties: type: type: string const: screenshot title: Type additionalProperties: true type: object required: - type title: Screenshot description: A screenshot 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. 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. 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. 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. 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: '#/components/schemas/ActionSearchSource' type: array - type: 'null' title: Sources additionalProperties: true type: object required: - type title: ActionSearch description: Action type "search" - Performs a web search query. 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. 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.' 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. ResponseInputImageContent: 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 additionalProperties: true type: object required: - type title: ResponseInputImageContent description: >- An image input to the model. Learn about [image inputs](https://platform.openai.com/docs/guides/vision) ResponseInputFileContent: properties: type: type: string const: input_file title: Type detail: anyOf: - type: string enum: - high - low - 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 additionalProperties: true type: object required: - type title: ResponseInputFileContent description: A file input to the model. 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. 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. 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. 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. 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. 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. LocalEnvironment: properties: type: type: string const: local title: Type skills: anyOf: - items: $ref: '#/components/schemas/LocalSkill' type: array - type: 'null' title: Skills additionalProperties: true type: object required: - type title: LocalEnvironment 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 ResponseFunctionShellCallOutputContent: properties: outcome: anyOf: - $ref: '#/components/schemas/OutcomeTimeout' - $ref: '#/components/schemas/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. 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. 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. 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. 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. 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. Output: properties: outcome: anyOf: - $ref: '#/components/schemas/OutputOutcomeTimeout' - $ref: '#/components/schemas/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. 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. 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. Used to generate structured JSON responses. Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs). ResponseFormatJSONObject: properties: type: type: string const: json_object title: Type additionalProperties: true type: object required: - type title: ResponseFormatJSONObject description: >- JSON object response format. An older method of generating JSON responses. Using `json_schema` is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so. 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. CompoundFilter: properties: filters: items: anyOf: - $ref: '#/components/schemas/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`. RankingOptions: properties: hybrid_search: anyOf: - $ref: '#/components/schemas/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. 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. 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. McpRequireApprovalMcpToolApprovalFilter: properties: always: anyOf: - $ref: >- #/components/schemas/McpRequireApprovalMcpToolApprovalFilterAlways - type: 'null' never: anyOf: - $ref: >- #/components/schemas/McpRequireApprovalMcpToolApprovalFilterNever - type: 'null' additionalProperties: true type: object title: McpRequireApprovalMcpToolApprovalFilter description: |- Specify which of the MCP server's tools require approval. Can be `always`, `never`, or a filter object associated with tools that require approval. 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: '#/components/schemas/ContainerNetworkPolicyDisabled' - $ref: '#/components/schemas/ContainerNetworkPolicyAllowlist' - type: 'null' title: Network Policy additionalProperties: true type: object required: - type title: CodeInterpreterContainerCodeInterpreterToolAuto description: |- Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on. 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. Contains `image_url` (string, optional) and `file_id` (string, optional). 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: '#/components/schemas/ContainerNetworkPolicyDisabled' - $ref: '#/components/schemas/ContainerNetworkPolicyAllowlist' - type: 'null' title: Network Policy skills: anyOf: - items: anyOf: - $ref: '#/components/schemas/SkillReference' - $ref: '#/components/schemas/InlineSkill' type: array - type: 'null' title: Skills additionalProperties: true type: object required: - type title: ContainerAuto Text: properties: type: type: string const: text title: Type additionalProperties: true type: object required: - type title: Text description: Unconstrained free-form text. 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. ToolFunction: properties: name: type: string title: Name type: type: string const: function title: Type defer_loading: anyOf: - type: boolean - type: 'null' title: Defer Loading description: anyOf: - type: string - type: 'null' title: Description 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 user's location. InputTokensDetails: properties: cached_tokens: type: integer title: Cached Tokens input_tokens_per_turn: items: type: integer type: array title: Input Tokens Per Turn cached_tokens_per_turn: items: type: integer type: array title: Cached Tokens Per Turn type: object required: - cached_tokens title: InputTokensDetails OutputTokensDetails: properties: reasoning_tokens: type: integer title: Reasoning Tokens default: 0 tool_output_tokens: type: integer title: Tool Output Tokens default: 0 output_tokens_per_turn: items: type: integer type: array title: Output Tokens Per Turn tool_output_tokens_per_turn: items: type: integer type: array title: Tool Output Tokens Per Turn type: object title: OutputTokensDetails 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. 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. 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. 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. Logprob: properties: token: type: string title: Token bytes: items: type: integer type: array title: Bytes logprob: type: number title: Logprob top_logprobs: items: $ref: '#/components/schemas/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. 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 }`.' 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 }`.' 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. 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 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. 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. 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. 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. 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. 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. 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. ContainerNetworkPolicyDisabled: properties: type: type: string const: disabled title: Type additionalProperties: true type: object required: - type title: ContainerNetworkPolicyDisabled ContainerNetworkPolicyAllowlist: properties: allowed_domains: items: type: string type: array title: Allowed Domains type: type: string const: allowlist title: Type domain_secrets: anyOf: - items: $ref: '#/components/schemas/ContainerNetworkPolicyDomainSecret' type: array - type: 'null' title: Domain Secrets additionalProperties: true type: object required: - allowed_domains - type title: ContainerNetworkPolicyAllowlist 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 InlineSkill: properties: description: type: string title: Description name: type: string title: Name source: $ref: '#/components/schemas/InlineSkillSource' type: type: string const: inline title: Type additionalProperties: true type: object required: - description - name - source - type title: InlineSkill 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. 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 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 securitySchemes: HTTPBearer: type: http scheme: bearer ````