id: String

The unique ID of the additional tools item.

role: :unknown | :user | :assistant | 5 more

The role that provided the additional tools.

One of the following:
:unknown
:user
:assistant
:system
:critic
:discriminator
:developer
:tool
tools: Array[BetaTool]

The additional tool definitions made available at this item.

One of the following:
class BetaFunctionTool { name, parameters, strict, 6 more }

Defines a function in your own code the model can choose to call. Learn more about function calling.

name: String

The name of the function to call.

parameters: Hash[Symbol, untyped]

A JSON schema object describing the parameters of the function.

strict: bool

Whether strict parameter validation is enforced for this function tool.

type: :function

The type of the function tool. Always function.

allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
async: bool
defer_loading: bool

Whether this function is deferred and loaded via tool search.

description: String

A description of the function. Used by the model to determine whether or not to call the function.

output_schema: Hash[Symbol, untyped]

A JSON schema object describing the JSON value encoded in string outputs for this function.

class BetaFileSearchTool { type, vector_store_ids, filters, 2 more }

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

type: :file_search

The type of the file search tool. Always file_search.

vector_store_ids: Array[String]

The IDs of the vector stores to search.

filters: ComparisonFilter{ key, type, value} | CompoundFilter{ filters, type}

A filter to apply.

One of the following:
class ComparisonFilter { key, type, value }

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

key: String

The key to compare against the value.

type: :eq | :ne | :gt | 5 more

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

  • eq: equals
  • ne: not equal
  • gt: greater than
  • gte: greater than or equal
  • lt: less than
  • lte: less than or equal
  • in: in
  • nin: not in
One of the following:
:eq
:ne
:gt
:gte
:lt
:lte
:in
:nin
value: String | Float | bool | Array[String | Float]

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:
String = String
Float = Float
UnionMember2 = bool
UnionMember3 = Array[String | Float]
One of the following:
String = String
Float = Float
class CompoundFilter { filters, type }

Combine multiple filters using and or or.

filters: Array[ComparisonFilter{ key, type, value} | untyped]

Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.

One of the following:
class ComparisonFilter { key, type, value }

A filter used to compare a specified attribute key to a given value using a defined comparison operation.

key: String

The key to compare against the value.

type: :eq | :ne | :gt | 5 more

Specifies the comparison operator: eq, ne, gt, gte, lt, lte, in, nin.

  • eq: equals
  • ne: not equal
  • gt: greater than
  • gte: greater than or equal
  • lt: less than
  • lte: less than or equal
  • in: in
  • nin: not in
One of the following:
:eq
:ne
:gt
:gte
:lt
:lte
:in
:nin
value: String | Float | bool | Array[String | Float]

The value to compare against the attribute key; supports string, number, or boolean types.

One of the following:
String = String
Float = Float
UnionMember2 = bool
UnionMember3 = Array[String | Float]
One of the following:
String = String
Float = Float
UnionMember1 = untyped
type: :and | :or

Type of operation: and or or.

One of the following:
:and
:or
max_num_results: Integer

The maximum number of results to return. This number should be between 1 and 50 inclusive.

ranking_options: RankingOptions{ hybrid_search, ranker, score_threshold}

Ranking options for search.

text_weight: Float

The weight of the text in the reciprocal ranking fusion.

ranker: :auto | :"default-2024-11-15"

The ranker to use for the file search.

One of the following:
:auto
:"default-2024-11-15"
score_threshold: Float

The score threshold for the file search, a number between 0 and 1. Numbers closer to 1 will attempt to return only the most relevant results, but may return fewer results.

class BetaComputerTool { type }

A tool that controls a virtual computer. Learn more about the computer tool.

type: :computer

The type of the computer tool. Always computer.

class BetaComputerUsePreviewTool { display_height, display_width, environment, type }

A tool that controls a virtual computer. Learn more about the computer tool.

display_height: Integer

The height of the computer display.

display_width: Integer

The width of the computer display.

environment: :windows | :mac | :linux | 2 more

The type of computer environment to control.

One of the following:
:windows
:mac
:linux
:ubuntu
:browser
type: :computer_use_preview

The type of the computer use tool. Always computer_use_preview.

class BetaWebSearchTool { type, external_web_access, filters, 2 more }

Search the Internet for sources related to the prompt. Learn more about the web search tool.

type: :web_search | :web_search_2025_08_26

The type of the web search tool. One of web_search or web_search_2025_08_26.

One of the following:
:web_search
:web_search_2025_08_26
external_web_access: bool

Allow live internet access for web search. Defaults to true when omitted. When false, the web search tool runs in offline/cache-only mode and will not fetch new external content.

filters: Filters{ allowed_domains}

Filters for the search.

allowed_domains: Array[String]

Allowed domains for the search. If not provided, all domains are allowed. Subdomains of the provided domains are allowed as well.

Example: ["pubmed.ncbi.nlm.nih.gov"]

search_context_size: :low | :medium | :high

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

One of the following:
:low
:medium
:high
user_location: UserLocation{ city, country, region, 2 more}

The approximate location of the user.

city: String

Free text input for the city of the user, e.g. San Francisco.

country: String

The two-letter ISO country code of the user, e.g. US.

region: String

Free text input for the region of the user, e.g. California.

timezone: String

The IANA timezone of the user, e.g. America/Los_Angeles.

type: :approximate

The type of location approximation. Always approximate.

class Mcp { server_label, type, allowed_callers, 9 more }

Give the model access to additional tools via remote Model Context Protocol (MCP) servers. Learn more about MCP.

server_label: String

A label for this MCP server, used to identify it in tool calls.

type: :mcp

The type of the MCP tool. Always mcp.

allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
allowed_tools: Array[String] | McpToolFilter{ read_only, tool_names}

List of allowed tool names or a filter object.

One of the following:
McpAllowedTools = Array[String]

A string array of allowed tool names

class McpToolFilter { read_only, tool_names }

A filter object to specify which tools are allowed.

read_only: bool

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

tool_names: Array[String]

List of allowed tool names.

authorization: String

An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.

connector_id: :connector_dropbox | :connector_gmail | :connector_googlecalendar | 5 more

Identifier for service connectors, like those available in ChatGPT. One of server_url, connector_id, or tunnel_id must be provided. Learn more about service connectors here.

Currently supported connector_id values are:

  • Dropbox: connector_dropbox
  • Gmail: connector_gmail
  • Google Calendar: connector_googlecalendar
  • Google Drive: connector_googledrive
  • Microsoft Teams: connector_microsoftteams
  • Outlook Calendar: connector_outlookcalendar
  • Outlook Email: connector_outlookemail
  • SharePoint: connector_sharepoint
One of the following:
:connector_dropbox
:connector_gmail
:connector_googlecalendar
:connector_googledrive
:connector_microsoftteams
:connector_outlookcalendar
:connector_outlookemail
:connector_sharepoint
defer_loading: bool

Whether this MCP tool is deferred and discovered via tool search.

headers: Hash[Symbol, String]

Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.

require_approval: McpToolApprovalFilter{ always, never} | :always | :never

Specify which of the MCP server’s tools require approval.

One of the following:
class McpToolApprovalFilter { always, never }

Specify which of the MCP server’s tools require approval. Can be always, never, or a filter object associated with tools that require approval.

always: Always{ read_only, tool_names}

A filter object to specify which tools are allowed.

read_only: bool

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

tool_names: Array[String]

List of allowed tool names.

never: Never{ read_only, tool_names}

A filter object to specify which tools are allowed.

read_only: bool

Indicates whether or not a tool modifies data or is read-only. If an MCP server is annotated with readOnlyHint, it will match this filter.

tool_names: Array[String]

List of allowed tool names.

McpToolApprovalSetting = :always | :never

Specify a single approval policy for all tools. One of always or never. When set to always, all tools will require approval. When set to never, all tools will not require approval.

One of the following:
:always
:never
server_description: String

Optional description of the MCP server, used to provide more context.

server_url: String

The URL for the MCP server. One of server_url, connector_id, or tunnel_id must be provided.

formaturi
tunnel_id: String

The Secure MCP Tunnel ID to use instead of a direct server URL. One of server_url, connector_id, or tunnel_id must be provided.

class CodeInterpreter { container, type, allowed_callers }

A tool that runs Python code to help generate a response to a prompt.

container: String | CodeInterpreterToolAuto{ type, file_ids, memory_limit, network_policy}

The code interpreter container. Can be a container ID or an object that specifies uploaded file IDs to make available to your code, along with an optional memory_limit setting.

One of the following:
String = String

The container ID.

class CodeInterpreterToolAuto { type, file_ids, memory_limit, network_policy }

Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.

type: :auto

Always auto.

file_ids: Array[String]

An optional list of uploaded files to make available to your code.

memory_limit: :"1g" | :"4g" | :"16g" | :"64g"

The memory limit for the code interpreter container.

One of the following:
:"1g"
:"4g"
:"16g"
:"64g"
network_policy: BetaContainerNetworkPolicyDisabled { type } | BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }

Network access policy for the container.

One of the following:
class BetaContainerNetworkPolicyDisabled { type }
type: :disabled

Disable outbound network access. Always disabled.

class BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }
allowed_domains: Array[String]

A list of allowed domains when type is allowlist.

type: :allowlist

Allow outbound network access only to specified domains. Always allowlist.

domain_secrets: Array[BetaContainerNetworkPolicyDomainSecret { domain, name, value } ]

Optional domain-scoped secrets for allowlisted domains.

domain: String

The domain associated with the secret.

minLength1
name: String

The name of the secret to inject for the domain.

minLength1
value: String

The secret value to inject for the domain.

minLength1
maxLength10485760
type: :code_interpreter

The type of the code interpreter tool. Always code_interpreter.

allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
class ProgrammaticToolCalling { type }
type: :programmatic_tool_calling

The type of the tool. Always programmatic_tool_calling.

class ImageGeneration { type, action, background, 9 more }

A tool that generates images using the GPT image models.

type: :image_generation

The type of the image generation tool. Always image_generation.

action: :generate | :edit | :auto

Whether to generate a new image or edit an existing image. Default: auto.

One of the following:
:generate
:edit
:auto
background: :transparent | :opaque | :auto

Allows to set transparency for the background of the generated image(s). Must be one of transparent, opaque, or auto (default value). When auto is used, the model will automatically determine the best background for the image.

Transparent backgrounds are available for supported GPT Image models. For gpt-image-2 and gpt-image-2-2026-04-21, this support is in preview. When using transparent, set the output format to png or webp.

One of the following:
:transparent
:opaque
:auto
input_fidelity: :high | :low

Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.

One of the following:
:high
:low
input_image_mask: InputImageMask{ file_id, image_url}

Optional mask for inpainting. Contains image_url (string, optional) and file_id (string, optional).

file_id: String

File ID for the mask image.

image_url: String

Base64-encoded mask image.

model: String | :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more

The image generation model to use. One of gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, or chatgpt-image-latest. Default: gpt-image-1.

One of the following:
String = String
Model = :"gpt-image-1" | :"gpt-image-1-mini" | :"gpt-image-2" | 3 more

The image generation model to use. One of gpt-image-1, gpt-image-1-mini, gpt-image-1.5, gpt-image-2, gpt-image-2-2026-04-21, or chatgpt-image-latest. Default: gpt-image-1.

One of the following:
:"gpt-image-1"
:"gpt-image-1-mini"
:"gpt-image-2"
:"gpt-image-2-2026-04-21"
:"gpt-image-1.5"
:"chatgpt-image-latest"
moderation: :auto | :low

Moderation level for the generated image. Default: auto.

One of the following:
:auto
:low
output_compression: Integer

Compression level for the output image. Default: 100.

minimum0
maximum100
output_format: :png | :webp | :jpeg

The output format of the generated image. One of png, webp, or jpeg. Default: png.

One of the following:
:png
:webp
:jpeg
partial_images: Integer

Number of partial images to generate in streaming mode, from 0 (default value) to 3.

minimum0
maximum3
quality: :low | :medium | :high | :auto

The quality of the generated image. One of low, medium, high, or auto. Default: auto.

One of the following:
:low
:medium
:high
:auto
size: String | :"1024x1024" | :"1024x1536" | :"1536x1024" | :auto

The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

One of the following:
String = String
Size = :"1024x1024" | :"1024x1536" | :"1536x1024" | :auto

The size of the generated images. For gpt-image-2 and gpt-image-2-2026-04-21, arbitrary resolutions are supported as WIDTHxHEIGHT strings, for example 1536x864. Width and height must both be divisible by 16 and the requested aspect ratio must be between 1:3 and 3:1. Resolutions above 2560x1440 are experimental, and the maximum supported resolution is 3840x2160. The requested size must also satisfy the model’s current pixel and edge limits. The standard sizes 1024x1024, 1536x1024, and 1024x1536 are supported by the GPT image models; auto is supported for models that allow automatic sizing. For dall-e-2, use one of 256x256, 512x512, or 1024x1024. For dall-e-3, use one of 1024x1024, 1792x1024, or 1024x1792.

One of the following:
:"1024x1024"
:"1024x1536"
:"1536x1024"
:auto
class LocalShell { type }

A tool that allows the model to execute shell commands in a local environment.

type: :local_shell

The type of the local shell tool. Always local_shell.

class BetaFunctionShellTool { type, allowed_callers, environment }

A tool that allows the model to execute shell commands.

type: :shell

The type of the shell tool. Always shell.

allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
environment: BetaContainerAuto { type, file_ids, memory_limit, 2 more } | BetaLocalEnvironment { type, skills } | BetaContainerReference { container_id, type }
One of the following:
class BetaContainerAuto { type, file_ids, memory_limit, 2 more }
type: :container_auto

Automatically creates a container for this request

file_ids: Array[String]

An optional list of uploaded files to make available to your code.

memory_limit: :"1g" | :"4g" | :"16g" | :"64g"

The memory limit for the container.

One of the following:
:"1g"
:"4g"
:"16g"
:"64g"
network_policy: BetaContainerNetworkPolicyDisabled { type } | BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }

Network access policy for the container.

One of the following:
class BetaContainerNetworkPolicyDisabled { type }
type: :disabled

Disable outbound network access. Always disabled.

class BetaContainerNetworkPolicyAllowlist { allowed_domains, type, domain_secrets }
allowed_domains: Array[String]

A list of allowed domains when type is allowlist.

type: :allowlist

Allow outbound network access only to specified domains. Always allowlist.

domain_secrets: Array[BetaContainerNetworkPolicyDomainSecret { domain, name, value } ]

Optional domain-scoped secrets for allowlisted domains.

domain: String

The domain associated with the secret.

minLength1
name: String

The name of the secret to inject for the domain.

minLength1
value: String

The secret value to inject for the domain.

minLength1
maxLength10485760
skills: Array[BetaSkillReference { skill_id, type, version } | BetaInlineSkill { description, name, source, type } ]

An optional list of skills referenced by id or inline data.

One of the following:
class BetaSkillReference { skill_id, type, version }
skill_id: String

The ID of the referenced skill.

minLength1
maxLength64
type: :skill_reference

References a skill created with the /v1/skills endpoint.

version: String

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

class BetaInlineSkill { description, name, source, type }
description: String

The description of the skill.

name: String

The name of the skill.

source: BetaInlineSkillSource { data, media_type, type }

Inline skill payload

data: String

Base64-encoded skill zip bundle.

minLength1
maxLength70254592
media_type: :"application/zip"

The media type of the inline skill payload. Must be application/zip.

type: :base64

The type of the inline skill source. Must be base64.

type: :inline

Defines an inline skill for this request.

class BetaLocalEnvironment { type, skills }
type: :local

Use a local computer environment.

skills: Array[BetaLocalSkill { description, name, path } ]

An optional list of skills.

description: String

The description of the skill.

name: String

The name of the skill.

path: String

The path to the directory containing the skill.

class BetaContainerReference { container_id, type }
container_id: String

The ID of the referenced container.

type: :container_reference

References a container created with the /v1/containers endpoint

class BetaCustomTool { name, type, allowed_callers, 4 more }

A custom tool that processes input using a specified format. Learn more about custom tools

name: String

The name of the custom tool, used to identify it in tool calls.

type: :custom

The type of the custom tool. Always custom.

allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
async: bool

Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

defer_loading: bool

Whether this tool should be deferred and discovered via tool search.

description: String

Optional description of the custom tool, used to provide more context.

format_: Text{ type} | Grammar{ definition, syntax, type}

The input format for the custom tool. Default is unconstrained text.

One of the following:
class Text { type }

Unconstrained free-form text.

type: :text

Unconstrained text format. Always text.

class Grammar { definition, syntax, type }

A grammar defined by the user.

definition: String

The grammar definition.

syntax: :lark | :regex

The syntax of the grammar definition. One of lark or regex.

One of the following:
:lark
:regex
type: :grammar

Grammar format. Always grammar.

class BetaNamespaceTool { description, name, tools, type }

Groups function/custom tools under a shared namespace.

description: String

A description of the namespace shown to the model.

name: String

The namespace name used in tool calls (for example, crm).

minLength1
tools: Array[Function{ name, type, allowed_callers, 6 more} | BetaCustomTool { name, type, allowed_callers, 4 more } ]

The function/custom tools available inside this namespace.

One of the following:
class Function { name, type, allowed_callers, 6 more }
name: String
minLength1
maxLength128
type: :function
allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
async: bool

Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

defer_loading: bool

Whether this function should be deferred and discovered via tool search.

description: String
output_schema: Hash[Symbol, untyped]

A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.

parameters: untyped
strict: bool

Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

class BetaCustomTool { name, type, allowed_callers, 4 more }

A custom tool that processes input using a specified format. Learn more about custom tools

name: String

The name of the custom tool, used to identify it in tool calls.

type: :custom

The type of the custom tool. Always custom.

allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
async: bool

Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

defer_loading: bool

Whether this tool should be deferred and discovered via tool search.

description: String

Optional description of the custom tool, used to provide more context.

format_: Text{ type} | Grammar{ definition, syntax, type}

The input format for the custom tool. Default is unconstrained text.

One of the following:
class Text { type }

Unconstrained free-form text.

type: :text

Unconstrained text format. Always text.

class Grammar { definition, syntax, type }

A grammar defined by the user.

definition: String

The grammar definition.

syntax: :lark | :regex

The syntax of the grammar definition. One of lark or regex.

One of the following:
:lark
:regex
type: :grammar

Grammar format. Always grammar.

type: :namespace

The type of the tool. Always namespace.

class BetaToolSearchTool { type, description, execution, parameters }

Hosted or BYOT tool search configuration for deferred tools.

type: :tool_search

The type of the tool. Always tool_search.

description: String

Description shown to the model for a client-executed tool search tool.

execution: :server | :client

Whether tool search is executed by the server or by the client.

One of the following:
:server
:client
parameters: untyped

Parameter schema for a client-executed tool search tool.

class BetaWebSearchPreviewTool { type, search_content_types, search_context_size, user_location }

This tool searches the web for relevant results to use in a response. Learn more about the web search tool.

type: :web_search_preview | :web_search_preview_2025_03_11

The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.

One of the following:
:web_search_preview
:web_search_preview_2025_03_11
search_content_types: Array[:text | :image]
One of the following:
:text
:image
search_context_size: :low | :medium | :high

High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.

One of the following:
:low
:medium
:high
user_location: UserLocation{ type, city, country, 2 more}

The user’s location.

type: :approximate

The type of location approximation. Always approximate.

city: String

Free text input for the city of the user, e.g. San Francisco.

country: String

The two-letter ISO country code of the user, e.g. US.

region: String

Free text input for the region of the user, e.g. California.

timezone: String

The IANA timezone of the user, e.g. America/Los_Angeles.

class BetaApplyPatchTool { type, allowed_callers }

Allows the assistant to create, delete, or update files using unified diffs.

type: :apply_patch

The type of the tool. Always apply_patch.

allowed_callers: Array[:direct | :programmatic]

The tool invocation context(s).

One of the following:
:direct
:programmatic
type: :additional_tools

The type of the item. Always additional_tools.

agent: Agent{ agent_name}

The agent that produced this item.

agent_name: String

The canonical name of the agent that produced this item.